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: Fix typo in max-len ignorePattern example. #9956

Merged
merged 1 commit into from Feb 7, 2018

Conversation

tmartin1
Copy link
Contributor

@tmartin1 tmartin1 commented Feb 7, 2018

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:

What changes did you make? (Give an overview)

Proposed change to the documentation for the max-men rule, specifically, the ignorePattern example (https://eslint.org/docs/rules/max-len#ignorepattern).

Proposed change is to add a \ to the ignorePattern example to properly escape the final (.

The current example of "ignorePattern": "^\\s*var\\s.+=\\s*require\\s*\(" results in an error due to the invalid escape character in the string because the final open parentheses character isn't properly escaped.

This changes the example to: "ignorePattern": "^\\s*var\\s.+=\\s*require\\s*\\(", which is properly escaped.

Is there anything you'd like reviewers to focus on?

No.

@jsf-clabot
Copy link

jsf-clabot commented Feb 7, 2018

CLA assistant check
All committers have signed the CLA.

@eslint-deprecated eslint-deprecated bot added the triage An ESLint team member will look at this issue soon label Feb 7, 2018
@tmartin1 tmartin1 changed the title Fix max-len ignorePattern example in the docs. Docs: Fix typo in max-len ignorePattern example. Feb 7, 2018
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@platinumazure platinumazure added rule Relates to ESLint's core rules documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Feb 7, 2018
@platinumazure platinumazure merged commit bf3d494 into eslint:master Feb 7, 2018
@platinumazure
Copy link
Member

Merged, thanks @tmartin1 for contributing!

This was referenced Mar 19, 2018
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Aug 7, 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 Aug 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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 rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants