docs: update rule docs to reflect if they are recommended correctly

gajus · Nov 7, 2024 · 873eae4 · 873eae4
1 parent a23977e
commit 873eae4
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 5 deletions.
diff --git a/.README/rules/check-access.md b/.README/rules/check-access.md
@@ -19,7 +19,7 @@ Also reports:
 |---|---|
 |Context|everywhere|
 |Tags|`@access`|
-|Recommended|false|
+|Recommended|true|
 |Settings||
 |Options||
 

diff --git a/.README/rules/lines-before-block.md b/.README/rules/lines-before-block.md
@@ -24,7 +24,7 @@ lines before the block will not be added).
 |---|---|
 |Context|everywhere|
 |Tags|N/A|
-|Recommended|true|
+|Recommended|false|
 |Settings||
 |Options|`excludedTags`, `ignoreSameLine`, `lines`|
 

diff --git a/.README/rules/no-defaults.md b/.README/rules/no-defaults.md
@@ -48,7 +48,7 @@ section of our README for more on the expected format.
 |Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
 |Tags|`param`, `default`|
 |Aliases|`arg`, `argument`, `defaultvalue`|
-|Recommended|false|
+|Recommended|true|
 |Options|`contexts`, `noOptionalParamNames`|
 
 ## Failing examples

diff --git a/.README/rules/require-asterisk-prefix.md b/.README/rules/require-asterisk-prefix.md
@@ -43,6 +43,7 @@ which applies to the main jsdoc block description.
 |---|---|
 |Context|everywhere|
 |Tags|All or as limited by the `tags` option|
+|Recommended|false|
 |Options|string ("always", "never", "any") followed by object with `tags`|
 
 ## Failing examples

diff --git a/.README/rules/require-template.md b/.README/rules/require-template.md
@@ -42,7 +42,7 @@ Defaults to `false`.
 |---|---|
 |Context|everywhere|
 |Tags|`template`|
-|Recommended|true|
+|Recommended|false|
 |Settings||
 |Options|`requireSeparateTemplates`|
 

diff --git a/.README/rules/require-throws.md b/.README/rules/require-throws.md
@@ -38,7 +38,7 @@ on why TypeScript doesn't offer such a feature.
 | Context  | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
 | Tags     | `throws` |
 | Aliases  | `exception` |
-|Recommended|true|
+|Recommended|false|
 | Options  |`contexts`, `exemptedBy`|
 | Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |