docs(check-tag-names): add docs on rejecting tags

gajus · Apr 24, 2023 · 95f126d · 95f126d
1 parent f3faa25
commit 95f126d
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git 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
@@ -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
+            }
+        }
+    }
+}
+```
+
 <a name="user-content-eslint-plugin-jsdoc-rules-check-tag-names-options-6"></a>
 <a name="eslint-plugin-jsdoc-rules-check-tag-names-options-6"></a>
 #### Options