Giters

huggingface / datasets

🤗 The largest hub of ready-to-use datasets for ML models with fast, easy-to-use and efficient data manipulation tools

Home Page:https://huggingface.co/docs/datasets

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

datasets template guide :: issue in documentation YAML

bghira opened this issue · comments

commented

Describe the bug

There is a YAML error at the top of the page, and I don't think it's supposed to be there

Steps to reproduce the bug

  1. Browse to this tutorial document
  2. Observe a big red error at the top
  3. The rest of the document remains functional

Expected behavior

I think the YAML block should be displayed or ignored.

Environment info

N/A

commented

Hello, @bghira.

Thanks for reporting. Please note that the text originating the error is not supposed to be valid YAML: it contains the instructions to generate the actual YAML content, that should replace the instructions comment.

On the other hand, I agree that it is not nice to have that YAML error message at the top of the page:
Screenshot from 2024-05-14 06-58-02

I am proposing a change to make the YAML error disappear.

commented

thanks albert! i looked at it for a while to figure it out. i think the raw view option is the correct way to look at it?