Docs: Add configuration comments in examples #13738
Merged
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
eslint-deprecated
bot
added
the
triage
yeonjuan
added
accepted
anikethsaha
approved these changes
Oct 5, 2020
mdjermanovic
reviewed
Oct 5, 2020
Comment on lines
29
to
36
| Examples of **incorrect** code for this rule: | ||
|
|
||
| ```js | ||
| /*eslint no-unmodified-loop-condition: "error"*/ | ||
|
|
||
| while (node) { | ||
| doSomething(node); | ||
| } |
There was a problem hiding this comment.
This doesn't seem to work in the demo (at least when I try), maybe the variables have to be declared?
@yeonjuan if this really should be fixed, what do you think about doing that in this PR or in another PR?
There was a problem hiding this comment.
if this really should be fixed, what do you think about doing that in this PR or in another PR?
@mdjermanovic I think doing in this PR nice. I fixed it. Thanks 👍
There was a problem hiding this comment.
Thanks! The example with for-loop also doesn't work, but that seems to be a more complex problem for another PR. I'm not sure what was the expected behavior.
eslint-github-bot
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
I added missing configuration comments in the documents. It's quite useful for a quick demo :)
Is there anything you'd like reviewers to focus on?
no.