diff --git a/.README/rules/require-jsdoc.md b/.README/rules/require-jsdoc.md index 4b4eda034..b04e380ef 100644 --- a/.README/rules/require-jsdoc.md +++ b/.README/rules/require-jsdoc.md @@ -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 diff --git a/README.md b/README.md index 9c5f0483c..8df6f607d 100644 --- a/README.md +++ b/README.md @@ -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. + ##### exemptEmptyConstructors