Skip to content

Commit 3e88f9a

Browse files
JoshuaKGoldbergbrettz9
authored andcommitted
docs: mention excludedTags in informative-docs docs
1 parent 783b4e9 commit 3e88f9a

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

.README/rules/informative-docs.md

+14
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ The default `aliases` option is:
3535
}
3636
```
3737

38+
### `excludedTags`
39+
40+
Tags that should not be checked for valid contents.
41+
42+
For example, with `{ excludedTags: ["category"] }`, the following comment would not be considered uninformative:
43+
44+
```js
45+
/** @category Types */
46+
function computeTypes(node) {
47+
// ...
48+
}
49+
50+
No tags are excluded by default.
51+
3852
### `uselessWords`
3953

4054
Words that are ignored when searching for one that adds meaning.

docs/rules/informative-docs.md

+16
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,22 @@ The default `aliases` option is:
4747
}
4848
```
4949

50+
<a name="user-content-informative-docs-options-excludedtags"></a>
51+
<a name="informative-docs-options-excludedtags"></a>
52+
### <code>excludedTags</code>
53+
54+
Tags that should not be checked for valid contents.
55+
56+
For example, with `{ excludedTags: ["category"] }`, the following comment would not be considered uninformative:
57+
58+
```js
59+
/** @category Types */
60+
function computeTypes(node) {
61+
// ...
62+
}
63+
64+
No tags are excluded by default.
65+
5066
<a name="user-content-informative-docs-options-uselesswords"></a>
5167
<a name="informative-docs-options-uselesswords"></a>
5268
### <code>uselessWords</code>

0 commit comments

Comments
 (0)