Docs: Improve examples for no-case-declarations (fixes #6716) #7920
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
|
@rangelke, thanks for your PR! By analyzing the history of the files in this pull request, we identified @arv, @pedrottimark and @scriptdaemon to be potential reviewers. |
|
|
|
LGTM |
arv
approved these changes
Jan 15, 2017
| @@ -39,7 +39,11 @@ Examples of **correct** code for this rule: | |||
| /*eslint no-case-declarations: "error"*/ | |||
| /*eslint-env es6*/ | |||
|
|
|||
| /* Declarations outside switch-statements are valid */ | |||
There was a problem hiding this comment.
By looking at other example code I think it is more common to use // comments.
|
LGTM |
|
@arv The appveyor build failed, could it be because of the name change of my commit? |
venikx
changed the title
vitorbal
added
documentation
vitorbal
approved these changes
Jan 18, 2017
|
@rangelke Thanks, this looks good! The appveyor build is green, maybe it just wasn't finished yet when you checked. |
This was referenced Jan 20, 2017
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.
What is the purpose of this pull request? (put an "X" next to 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:
PR for the following issue #6716
What changes did you make? (Give an overview)
I added two examples where no-case-declarations are used correctly, one declaration outside the switch-statement and one using var.
The first the block scope of a case is introduced I added a comment to make it clearer where brackets should be used.
Is there anything you'd like reviewers to focus on?
I have troubles with an appropriate commit message. Is it too vague? If so, any proposals, since it's hard to keep in the 72 character limit?