Skip to content

Commit 307bc33

Browse files
committed
docs: note possible performance penalty of matchingFileName setting for check-examples
1 parent 8cff358 commit 307bc33

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.README/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,8 @@ decreasing precedence:
365365
with JavaScript Markdown lintable by
366366
[other plugins](https://github.com/eslint/eslint-plugin-markdown), e.g.,
367367
if one sets `matchingFileName` to `dummy.md` so that `@example` rules will
368-
follow one's Markdown rules).
368+
follow one's Markdown rules). Note that this option may come at somewhat
369+
of a performance penalty as the file's existence is checked by eslint.
369370
* `settings.jsdoc.configFile` - A config file. Corresponds to ESLint's `-c`.
370371
* `settings.jsdoc.eslintrcForExamples` - Defaults to `true` in adding rules
371372
based on an `.eslintrc.*` file. Setting to `false` corresponds to

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,8 @@ decreasing precedence:
422422
with JavaScript Markdown lintable by
423423
[other plugins](https://github.com/eslint/eslint-plugin-markdown), e.g.,
424424
if one sets `matchingFileName` to `dummy.md` so that `@example` rules will
425-
follow one's Markdown rules).
425+
follow one's Markdown rules). Note that this option may come at somewhat
426+
of a performance penalty as the file's existence is checked by eslint.
426427
* `settings.jsdoc.configFile` - A config file. Corresponds to ESLint's `-c`.
427428
* `settings.jsdoc.eslintrcForExamples` - Defaults to `true` in adding rules
428429
based on an `.eslintrc.*` file. Setting to `false` corresponds to

0 commit comments

Comments
 (0)