Skip to content

Commit

Permalink
docs: mention excludedTags in informative-docs docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaKGoldberg authored and brettz9 committed Mar 25, 2024
1 parent 783b4e9 commit 3e88f9a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .README/rules/informative-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
16 changes: 16 additions & 0 deletions docs/rules/informative-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit 3e88f9a

Please sign in to comment.