]> git.proxmox.com Git - pve-eslint.git/blobdiff - eslint/docs/rules/lines-around-comment.md
import 7.12.1 upstream release
[pve-eslint.git] / eslint / docs / rules / lines-around-comment.md
index 61af596981307f5c7f1f9bdd6a8c0143820ea7e4..ae543bd837b8aff760ee2e3ffdcbcbeb0383bd42 100644 (file)
@@ -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: