Skip to content

Commit

Permalink
docs: update doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed Nov 6, 2024
1 parent e2aa8ff commit a23977e
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/rules/check-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Also reports:
|---|---|
|Context|everywhere|
|Tags|`@access`|
|Recommended|true|
|Recommended|false|
|Settings||
|Options||

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/lines-before-block.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ lines before the block will not be added).
|---|---|
|Context|everywhere|
|Tags|N/A|
|Recommended|false|
|Recommended|true|
|Settings||
|Options|`excludedTags`, `ignoreSameLine`, `lines`|

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-defaults.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,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|true|
|Recommended|false|
|Options|`contexts`, `noOptionalParamNames`|

<a name="user-content-no-defaults-failing-examples"></a>
Expand Down
1 change: 0 additions & 1 deletion docs/rules/require-asterisk-prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ 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`|

<a name="user-content-failing-examples"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Defaults to `false`.
|---|---|
|Context|everywhere|
|Tags|`template`|
|Recommended|false|
|Recommended|true|
|Settings||
|Options|`requireSeparateTemplates`|

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-throws.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ on why TypeScript doesn't offer such a feature.
| Context | `ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled |
| Tags | `throws` |
| Aliases | `exception` |
|Recommended|false|
|Recommended|true|
| Options |`contexts`, `exemptedBy`|
| Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |

Expand Down

0 comments on commit a23977e

Please sign in to comment.