From f2aef87e42db465fdc11dc346c88dbac12c8f466 Mon Sep 17 00:00:00 2001 From: Reece Dunham Date: Mon, 5 Feb 2024 20:08:14 +0000 Subject: [PATCH] fix(informative-docs): Improve wording in rule description --- .README/README.md | 2 +- .README/rules/informative-docs.md | 2 +- README.md | 2 +- docs/rules/informative-docs.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.README/README.md b/.README/README.md index 691fc30b8..dd634b97d 100644 --- a/.README/README.md +++ b/.README/README.md @@ -238,7 +238,7 @@ non-default-recommended fixer). |:heavy_check_mark:||[check-values](./docs/rules/check-values.md#readme)|Checks for expected content within some miscellaneous tags (`@version`, `@since`, `@license`, `@author`)| |:heavy_check_mark:|:wrench:|[empty-tags](./docs/rules/empty-tags.md#readme)|Checks tags that are expected to be empty (e.g., `@abstract` or `@async`), reporting if they have content| |:heavy_check_mark:||[implements-on-classes](./docs/rules/implements-on-classes.md#readme)|Prohibits use of `@implements` on non-constructor functions (to enforce the tag only being used on classes/constructors)| -|||[informative-docs](./docs/rules/informative-docs.md#readme)|Reports on JSDoc texts that serve only to restart their attached name.| +|||[informative-docs](./docs/rules/informative-docs.md#readme)|Reports on JSDoc texts that serve only to restate their attached name.| |||[match-description](./docs/rules/match-description.md#readme)|Defines customizable regular expression rules for your tag descriptions| ||:wrench:|[match-name](./docs/rules/match-name.md#readme)|Reports the name portion of a JSDoc tag if matching or not matching a given regular expression| |:heavy_check_mark:|:wrench:|[multiline-blocks](./docs/rules/multiline-blocks.md#readme)|Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks| diff --git a/.README/rules/informative-docs.md b/.README/rules/informative-docs.md index 5aa44948b..90420a5a4 100644 --- a/.README/rules/informative-docs.md +++ b/.README/rules/informative-docs.md @@ -2,7 +2,7 @@ {"gitdown": "contents", "rootId": "informative-docs"} -Reports on JSDoc texts that serve only to restart their attached name. +Reports on JSDoc texts that serve only to restate their attached name. Devs sometimes write JSDoc descriptions that add no additional information just to fill out the doc: diff --git a/README.md b/README.md index a96bc2e72..5c4192ac2 100644 --- a/README.md +++ b/README.md @@ -265,7 +265,7 @@ non-default-recommended fixer). |:heavy_check_mark:||[check-values](./docs/rules/check-values.md#readme)|Checks for expected content within some miscellaneous tags (`@version`, `@since`, `@license`, `@author`)| |:heavy_check_mark:|:wrench:|[empty-tags](./docs/rules/empty-tags.md#readme)|Checks tags that are expected to be empty (e.g., `@abstract` or `@async`), reporting if they have content| |:heavy_check_mark:||[implements-on-classes](./docs/rules/implements-on-classes.md#readme)|Prohibits use of `@implements` on non-constructor functions (to enforce the tag only being used on classes/constructors)| -|||[informative-docs](./docs/rules/informative-docs.md#readme)|Reports on JSDoc texts that serve only to restart their attached name.| +|||[informative-docs](./docs/rules/informative-docs.md#readme)|Reports on JSDoc texts that serve only to restate their attached name.| |||[match-description](./docs/rules/match-description.md#readme)|Defines customizable regular expression rules for your tag descriptions| ||:wrench:|[match-name](./docs/rules/match-name.md#readme)|Reports the name portion of a JSDoc tag if matching or not matching a given regular expression| |:heavy_check_mark:|:wrench:|[multiline-blocks](./docs/rules/multiline-blocks.md#readme)|Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks| diff --git a/docs/rules/informative-docs.md b/docs/rules/informative-docs.md index bce9290bf..2d597b5df 100644 --- a/docs/rules/informative-docs.md +++ b/docs/rules/informative-docs.md @@ -10,7 +10,7 @@ * [Passing examples](#user-content-informative-docs-passing-examples) -Reports on JSDoc texts that serve only to restart their attached name. +Reports on JSDoc texts that serve only to restate their attached name. Devs sometimes write JSDoc descriptions that add no additional information just to fill out the doc: