Skip to content

Commit

Permalink
docs(require-jsdoc): explain connection to require and link to AS…
Browse files Browse the repository at this point in the history
…T section
  • Loading branch information
brettz9 committed Jan 20, 2021
1 parent 7b9c1bd commit 4fd1cc4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .README/rules/require-jsdoc.md
Expand Up @@ -43,6 +43,12 @@ and can have an `inlineCommentBlock` property which, if set to `true`, will
add an inline `/** */` instead of the regular, multi-line, indented jsdoc
block which will otherwise be added. Defaults to an empty array.

Note that you may need to disable `require` items (e.g., `MethodDefinition`)
if you are specifying a more precise form in `contexts` (e.g., `MethodDefinition:not([accessibility="private"])`).

See the ["AST and Selectors"](#eslint-plugin-jsdoc-advanced-ast-and-selectors)
section of our README for more on the expected format.

##### `exemptEmptyConstructors`

Default: true
Expand Down
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -9746,6 +9746,12 @@ and can have an `inlineCommentBlock` property which, if set to `true`, will
add an inline `/** */` instead of the regular, multi-line, indented jsdoc
block which will otherwise be added. Defaults to an empty array.
Note that you may need to disable `require` items (e.g., `MethodDefinition`)
if you are specifying a more precise form in `contexts` (e.g., `MethodDefinition:not([accessibility="private"])`).
See the ["AST and Selectors"](#eslint-plugin-jsdoc-advanced-ast-and-selectors)
section of our README for more on the expected format.
<a name="eslint-plugin-jsdoc-rules-require-jsdoc-options-22-exemptemptyconstructors"></a>
##### <code>exemptEmptyConstructors</code>
Expand Down

0 comments on commit 4fd1cc4

Please sign in to comment.