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

Bad use of YAML document start (---) in examples #1513

Open
lindhe opened this issue Oct 9, 2023 · 0 comments
Open

Bad use of YAML document start (---) in examples #1513

lindhe opened this issue Oct 9, 2023 · 0 comments

Comments

@lindhe
Copy link
Contributor

lindhe commented Oct 9, 2023

I've seen that the YAML document start marker (---) is sometimes placed at the end of YAML documents in the examples:

https://github.com/helm/helm-www/blob/3e2a35f2e91f3529543bb8faca463ba5d6be9df8/content/en/docs/chart_template_guide/variables.md?plain=1#L149C1-L149C4

I have seen this mislead people to believe that this marker should be there even when there's only a single document:

like: this
---

I think it would be better if our examples consistently used --- as it is intended to be used – exclusively at the start of new documents (and optionally omitted when there's only a single document).

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

No branches or pull requests

1 participant