Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Small typo at 'generator-star-spacing' docs #8027

Closed
AuthorProxy opened this issue Feb 4, 2017 · 5 comments · Fixed by renovatebot/renovate#111 · May be fixed by iamhunter/teammates#4
Closed

Small typo at 'generator-star-spacing' docs #8027

AuthorProxy opened this issue Feb 4, 2017 · 5 comments · Fixed by renovatebot/renovate#111 · May be fixed by iamhunter/teammates#4
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue rule Relates to ESLint's core rules

Comments

@AuthorProxy
Copy link

http://eslint.org/docs/rules/generator-star-spacing

At options block:

The default is {"before": true, "after": false}.
"generator-star-spacing": ["error", {"before": false, "after": true}]

This introduce some misunderstanding what is 'true' default.
@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Feb 4, 2017
@AuthorProxy AuthorProxy changed the title Small typo at generator-star-spacing docs Small typo at 'generator-star-spacing' docs Feb 4, 2017
@platinumazure platinumazure added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules and removed triage An ESLint team member will look at this issue soon labels Feb 4, 2017
@platinumazure
Copy link
Member

platinumazure commented Feb 4, 2017 •
edited

Hi @AuthorProxy, thanks for the issue. I agree, that wording is confusing.

According to the rule source, { before: true, after: false } is correct.

Would you like to submit a pull request?

@kaicataldo kaicataldo added good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue labels Feb 6, 2017
@hoatran1403
Copy link
Contributor

Can I help to fix this with a PR?

@AuthorProxy
Copy link
Author

Sure

@alberto
Copy link
Member

alberto commented Feb 6, 2017

Actually, it's not a typo. Just an example of how to define the rule using the options object, so it should indicate that.

hoatran1403 added a commit to hoatran1403/eslint that referenced this issue Feb 7, 2017
@hoatran1403
Docs: Change the generator-star-spacing options example (fixes eslint…
6f5a084 
…#8027)
@hoatran1403 hoatran1403 mentioned this issue Feb 7, 2017
Merged
@hoatran1403
Copy link
Contributor

@alberto yeah, that's just an example

hoatran1403 added a commit to hoatran1403/eslint that referenced this issue Feb 7, 2017
@hoatran1403
Docs: Change the generator-star-spacing options example (fixes eslint…
63161cf 
…#8027)
This was referenced Feb 20, 2017
Merged
Merged
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before help wanted The team would welcome a contribution from the community for this issue rule Relates to ESLint's core rules
Projects
None yet
Milestone
No milestone
6 participants
@alberto @platinumazure @AuthorProxy @kaicataldo @hoatran1403 @eslintbot