Docs: Change the generator-star-spacing options example (fixes #8027) #8034
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
|
@hoatran1403, thanks for your PR! By analyzing the history of the files in this pull request, we identified @btmills, @IanVS and @mysticatea to be potential reviewers. |
|
|
|
LGTM |
kaicataldo
suggested changes
Feb 7, 2017
There was a problem hiding this comment.
Thanks for contributing! Would you mind updating this with the suggestion in this comment, as well as signing the CLA?
docs/rules/generator-star-spacing.md
Outdated
| @@ -59,7 +59,7 @@ The rule takes one option, an object, which has two keys `before` and `after` ha | |||
| The default is `{"before": true, "after": false}`. | |||
|
|
|||
| ```json | |||
| "generator-star-spacing": ["error", {"before": false, "after": true}] | |||
| "generator-star-spacing": ["error", {"before": true, "after": false}] | |||
There was a problem hiding this comment.
It looks like this was intended to be a general example of how to configure the rule rather than showing another example of the default configuration. Perhaps something along the lines of:
An example configuration:
"generator-star-spacing": ["error", {"before": true, "after": false}]We'll probably want a comment before the shorthand configuration on line 72 as well.
hoatran1403
force-pushed
the
issue8027
branch
from
6f5a084
to
63161cf
Compare
|
LGTM |
|
@kaicataldo Thanks for your review, I just fixed it. |
kaicataldo
approved these changes
Feb 7, 2017
This was referenced Feb 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:
#8027
What changes did you make? (Give an overview)
In file generator-star-spacing.md, Made changes in an example of Options from
"generator-star-spacing": ["error", {"before": false, "after": true}]to
"generator-star-spacing": ["error", {"before": true, "after": false}]Is there anything you'd like reviewers to focus on?
This is my first contribution to eslint, i'm not sure whether it matched with all the conventions or not( even though I've followed your pull request guide). Just let me know if there is any conflicts.
Thank you