Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

User Guide has incorrect example code comments in "unicode-bom" rule page #589

Closed
BrandonYeager opened this issue Jul 2, 2019 · 3 comments
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion bug The site is working incorrectly

Comments

@BrandonYeager
Copy link

BrandonYeager commented Jul 2, 2019

The example code in the page for the unicode-bom rule has incorrect comments (https://eslint.org/docs/rules/unicode-bom#require-or-disallow-the-unicode-byte-order-mark-bom-unicode-bom).

The "always" examples should say /*eslint unicode-bom: ["error", "always"]*/
The "never" examples should say /*eslint unicode-bom: "error"*/


See screenshot for a clearer explanation...

unicode-bom_UserGuideErrors

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Jul 2, 2019
@kaicataldo
Copy link
Member

Nice catch! This does indeed seem to be a bug. Our documentation actually live in https://github.com/eslint/eslint (we copy over those files to this repo when we run releases). Do you mind making an issue over there? PRs are always welcome, as well!

@kaicataldo kaicataldo added accepted There is consensus among the team that this change meets the criteria for inclusion bug The site is working incorrectly and removed triage An ESLint team member will look at this issue soon labels Jul 2, 2019
@BrandonYeager
Copy link
Author

Done! (eslint/eslint#11937)

I'll look into submitting a PR. I haven't done a lot of collaboration on open source projects, so I'll see if I can figure it out. Thanks for reply and the direction! I really appreciate how quickly you guys respond to issues!

@kaicataldo
Copy link
Member

That's fantastic! Hopefully our documentation answers any questions you have, but please feel free to comment on the issue or visit our chat if you any questions!

I'm going to close this issue in favor of the new one.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion bug The site is working incorrectly
Projects
None yet
Development

No branches or pull requests

2 participants