Docs: clarify usage of inline disable comments (fixes #6335) #6347
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
LGTM |
|
|
||
| ```js | ||
| /* eslint-disable */ | ||
|
|
||
| // Disables all rules between comments |
There was a problem hiding this comment.
After looking at this again, having these explanation comments is REALLY confusing when we're telling users to look at how to format comments to disable rules inline. I think it's clearer with them gone.
| alert('foo'); | ||
| ``` | ||
|
|
||
| You can also disable specific rules for an entire file: | ||
| You can also disable or enable specific rules for an entire file: |
There was a problem hiding this comment.
Keeping the wording consistent
|
LGTM |
|
LGTM. @pedrottimark Just a note for the future, we should add a section somewhere that explains that globals, eslint and exported are always block style comments and are hoisted, but eslint-disable/eslint-enable are block style but not hoisted. And eslint-disable-line and eslint-disable-next-line are always inline and not hoisted. |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Agreed with the user that this could be clearer, figured I could take a few minutes to try to make it better :)