Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

datasets template guide :: issue in documentation YAML #6897

Closed
bghira opened this issue May 13, 2024 · 2 comments · Fixed by #6898
Closed

datasets template guide :: issue in documentation YAML #6897

bghira opened this issue May 13, 2024 · 2 comments · Fixed by #6898
Assignees

Comments

@bghira
Copy link

bghira commented May 13, 2024

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

@albertvillanova albertvillanova self-assigned this May 14, 2024
@albertvillanova
Copy link
Member

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.

@bghira
Copy link
Author

bghira commented May 14, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants