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

Docs: Clarify that ignorePattern should be a string (refs #13029) #13718

Merged
merged 2 commits into from Sep 26, 2020
Merged

Docs: Clarify that ignorePattern should be a string (refs #13029) #13718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56ca4cf
Docs: Clarify that ignorePattern should be a string (refs #13029)
btmills Sep 26, 2020
b451988
Clarify ignorePattern option adds to default patterns
btmills Sep 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/lines-around-comment.md
View file
Open in desktop
Expand Up @@ -437,7 +437,7 @@ const [

### ignorePattern

By default this rule ignores comments starting with the following words: `eslint`, `jshint`, `jslint`, `istanbul`, `global`, `exported`, `jscs`. An alternative regular expression can be provided.
By default this rule ignores comments starting with the following words: `eslint`, `jshint`, `jslint`, `istanbul`, `global`, `exported`, `jscs`. To ignore more comments in addition to the defaults, set the `ignorePattern` option to a string pattern that will be passed to the [`RegExp` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp).

Examples of **correct** code for the `ignorePattern` option:

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-inline-comments.md
View file
Open in desktop
Expand Up @@ -92,7 +92,7 @@ var quux = (

### ignorePattern

A regular expression can be provided to make this rule ignore specific comments.
To make this rule ignore specific comments, set the `ignorePattern` option to a string pattern that will be passed to the [`RegExp` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp).

Examples of **correct** code for the `ignorePattern` option:

Expand Down