diff --git a/.README/rules/check-tag-names.md b/.README/rules/check-tag-names.md index 83797184f..f5d20f8ef 100644 --- a/.README/rules/check-tag-names.md +++ b/.README/rules/check-tag-names.md @@ -174,6 +174,22 @@ typeSummary wizaction ``` +If you instead wish to reject a normally valid tag, e.g., `@todo`, one may set the +tag to `false`: + +```json +{ + "rules": {}, + "settings": { + "jsdoc": { + "tagNamePreference": { + "todo": false + } + } + } +} +``` + #### Options ##### `definedTags` diff --git a/README.md b/README.md index 00c6b6e8d..40b144a13 100644 --- a/README.md +++ b/README.md @@ -4471,6 +4471,22 @@ typeSummary wizaction ``` +If you instead wish to reject a normally valid tag, e.g., `@todo`, one may set the +tag to `false`: + +```json +{ + "rules": {}, + "settings": { + "jsdoc": { + "tagNamePreference": { + "todo": false + } + } + } +} +``` + #### Options