question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

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

See original GitHub issue

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

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

3reactions
BrandonYeagercommented, Jul 3, 2019

@platinumazure Thank you for the information and the rapid responses to my questions! You guys are doing an awesome job!

0reactions
platinumazurecommented, Jul 3, 2019

@BrandonYeager Our commit message check looks at the PR title if there are 2 or more commits in the PR, because that’s what the suggested commit message is when we squash/merge. (If there is 1 commit, the first commit’s message is used instead, and our commit message check looks at the commit message for that reason.) So you can put whatever you want in the later commit messages.

Read more comments on GitHub >

github_iconTop Results From Across the Web

User Guide has incorrect example code comments in "unicode ...
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- ...
Read more >
unicode-bom - ESLint - Pluggable JavaScript Linter
A pluggable and configurable linter tool for identifying and reporting on patterns in JavaScript. Maintain your code quality with ease.
Read more >
Best practices for writing code comments - Stack Overflow Blog
A bad comment is worse than no comment at all. Here are some rules to help you achieve a happy medium. Avatar for...
Read more >
Changelog | Stylelint
Fixed: exit code when nothing is passed to stylelint command (#6175). Fixed: rule message function type to not require users to handle all...
Read more >
MSC55-J. Use comments consistently and in a readable fashion
This noncompliant code example uses the character sequence /* to begin a comment but neglects to use the delimiter */ to end the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found