docs: mention excludedTags in informative-docs docs

gajus · Mar 25, 2024 · 32a6f36 · 32a6f36
1 parent 783b4e9
commit 32a6f36
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/.README/rules/informative-docs.md b/.README/rules/informative-docs.md
@@ -35,6 +35,20 @@ The default `aliases` option is:
 }
 ```
 
+### `excludedTags`
+
+Tags that should not be checked for valid contents.
+
+For example, with `{ excludedTags: ["category"] }`, the following comment would not be considered uninformative:
+
+```js
+/** @category Types */
+function computeTypes(node) {
+  // ...
+}
+
+No tags are excluded by default.
+
 ### `uselessWords`
 
 Words that are ignored when searching for one that adds meaning.

diff --git a/docs/rules/informative-docs.md b/docs/rules/informative-docs.md
@@ -47,6 +47,22 @@ The default `aliases` option is:
 }
 ```
 
+<a name="user-content-informative-docs-options-excludedtags"></a>
+<a name="informative-docs-options-excludedtags"></a>
+### <code>excludedTags</code>
+
+Tags that should not be checked for valid contents.
+
+For example, with `{ excludedTags: ["category"] }`, the following comment would not be considered uninformative:
+
+```js
+/** @category Types */
+function computeTypes(node) {
+  // ...
+}
+
+No tags are excluded by default.
+
 <a name="user-content-informative-docs-options-uselesswords"></a>
 <a name="informative-docs-options-uselesswords"></a>
 ### <code>uselessWords</code>