Skip to content

Commit 873eae4

Browse files
CloudNStoyanbrettz9
authored andcommitted
docs: update rule docs to reflect if they are recommended correctly
1 parent a23977e commit 873eae4

6 files changed

+6
-5
lines changed

.README/rules/check-access.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Also reports:
1919
|---|---|
2020
|Context|everywhere|
2121
|Tags|`@access`|
22-
|Recommended|false|
22+
|Recommended|true|
2323
|Settings||
2424
|Options||
2525

.README/rules/lines-before-block.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ lines before the block will not be added).
2424
|---|---|
2525
|Context|everywhere|
2626
|Tags|N/A|
27-
|Recommended|true|
27+
|Recommended|false|
2828
|Settings||
2929
|Options|`excludedTags`, `ignoreSameLine`, `lines`|
3030

.README/rules/no-defaults.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ section of our README for more on the expected format.
4848
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
4949
|Tags|`param`, `default`|
5050
|Aliases|`arg`, `argument`, `defaultvalue`|
51-
|Recommended|false|
51+
|Recommended|true|
5252
|Options|`contexts`, `noOptionalParamNames`|
5353

5454
## Failing examples

.README/rules/require-asterisk-prefix.md

+1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ which applies to the main jsdoc block description.
4343
|---|---|
4444
|Context|everywhere|
4545
|Tags|All or as limited by the `tags` option|
46+
|Recommended|false|
4647
|Options|string ("always", "never", "any") followed by object with `tags`|
4748

4849
## Failing examples

.README/rules/require-template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Defaults to `false`.
4242
|---|---|
4343
|Context|everywhere|
4444
|Tags|`template`|
45-
|Recommended|true|
45+
|Recommended|false|
4646
|Settings||
4747
|Options|`requireSeparateTemplates`|
4848

.README/rules/require-throws.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ on why TypeScript doesn't offer such a feature.
3838
| Context | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
3939
| Tags | `throws` |
4040
| Aliases | `exception` |
41-
|Recommended|true|
41+
|Recommended|false|
4242
| Options |`contexts`, `exemptedBy`|
4343
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |
4444

0 commit comments

Comments
 (0)