From 32a6f36a903a05ee040a277953459eca36e10321 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Mon, 25 Mar 2024 11:04:43 -0400 Subject: [PATCH] docs: mention excludedTags in informative-docs docs --- .README/rules/informative-docs.md | 14 ++++++++++++++ docs/rules/informative-docs.md | 16 ++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/.README/rules/informative-docs.md b/.README/rules/informative-docs.md index 90420a5a4..1c9234425 100644 --- 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 index 027d4e1fa..60eaf3204 100644 --- a/docs/rules/informative-docs.md +++ b/docs/rules/informative-docs.md @@ -47,6 +47,22 @@ 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