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.

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

Docs: wrong example code for "exceptions" option in id-length rule #6397

Closed
cristian-sima opened this issue Jun 13, 2016 · 7 comments
Closed
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before

Comments

@cristian-sima
Copy link

http://eslint.org/docs/rules/id-length#exceptions

It is taking about exceptions, but there is a max property

@eslintbot eslintbot added the triage An ESLint team member will look at this issue soon label Jun 13, 2016
@vitorbal vitorbal added bug ESLint is working incorrectly documentation Relates to ESLint's documentation and removed bug ESLint is working incorrectly labels Jun 13, 2016
@vitorbal
Copy link
Member

Hi @cristian-sima, thank you for the issue!
Indeed it seems like the documentation example is wrong and the option being passed should have been { "exceptions": "x" } instead.
Would you be willing to open a Pull Request to fix it?

@vitorbal vitorbal changed the title Something is strange here Docs: wrong example code for "exceptions" option in id-length rule Jun 13, 2016
@pedrottimark
Copy link
Member

@cristian-sima Good eyes. Welcome to ESLint! Yes, it is a copy-and-paste error.

Therefore, the option needs to be { "exceptions": ["x"] } in the paragraph and the eslint comment.

@cristian-sima Here are the Contributing Guidelines: http://eslint.org/docs/developer-guide/contributing/
Note especially the Docs tag and length limit (irony here :) for the commit message in http://eslint.org/docs/developer-guide/contributing/pull-requests#step-2-make-your-changesa-namestep2a

@platinumazure platinumazure added bug ESLint is working incorrectly and removed triage An ESLint team member will look at this issue soon labels Jun 16, 2016
@vitorbal
Copy link
Member

ping @cristian-sima just checking if you would be willing to work on this one. No problem at all if you can't, just let us know :)

@kaicataldo kaicataldo added the good first issue Good for people who haven't worked on ESLint before label Jun 19, 2016
@GramParallelo
Copy link
Contributor

I'm looking to contribute my first PR to gain some experience. From what I see this issue seems possible for me to do and tagged beginner. May I try? ( if so, can I get a little helping hand? :-) ) Thanks!

@platinumazure
Copy link
Member

Hi @GramParallelo, thanks for stepping up! It looks like @kaicataldo might be working on this- hopefully he can clarify whether he is or not.

If you're looking for a good first pull request area, try filtering the issues to include the "beginner" label. If you can't see one, feel free to visit us in our chat room.

@kaicataldo
Copy link
Member

I'm not working on this - just labeled it as I thought it would be a great issue for a newcomer to the project to start with :) Thanks for contributing, @GramParallelo!

@vitorbal
Copy link
Member

vitorbal commented Jul 4, 2016

@GramParallelo this comment should help you get started, let us know if you need any help!

GramParallelo added a commit to GramParallelo/eslint that referenced this issue Jul 4, 2016
Changed 2 typos:
exceptions accepts array,
was max property instead of exception property.
GramParallelo added a commit to GramParallelo/eslint that referenced this issue Jul 4, 2016
Changed 2 typos:
exceptions accepts array,
was max property instead of exception property.
GramParallelo added a commit to GramParallelo/eslint that referenced this issue Jul 4, 2016
Changed 2 typos:
exceptions accepts array,
was max property instead of exception property.
GramParallelo added a commit to GramParallelo/eslint that referenced this issue Jul 4, 2016
Changed 2 typos:
exceptions accepts array,
was max property instead of exception property.
@nzakas nzakas closed this as completed in e9a2ed9 Jul 5, 2016
@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.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion bug ESLint is working incorrectly documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects
None yet
Development

No branches or pull requests

7 participants