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

…3718) * Docs: Clarify that ignorePattern should be a string (refs #13029) * Clarify ignorePattern option adds to default patterns
eslint · Sep 26, 2020 · 6919fbb · 6919fbb
1 parent 07d9bea
commit 6919fbb
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/rules/lines-around-comment.md b/docs/rules/lines-around-comment.md
@@ -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:
 

diff --git a/docs/rules/no-inline-comments.md b/docs/rules/no-inline-comments.md
@@ -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: