From 026fcc0ed5f0d4e5ad1625bbf3c1a173f5da270d Mon Sep 17 00:00:00 2001 From: Stoyan Kolev Date: Thu, 7 Nov 2024 09:51:22 +0200 Subject: [PATCH] run the create-docs script --- docs/rules/check-access.md | 2 +- docs/rules/lines-before-block.md | 2 +- docs/rules/no-defaults.md | 2 +- docs/rules/require-asterisk-prefix.md | 1 + docs/rules/require-template.md | 2 +- docs/rules/require-throws.md | 2 +- 6 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/rules/check-access.md b/docs/rules/check-access.md index 06f58bd5..12864506 100644 --- a/docs/rules/check-access.md +++ b/docs/rules/check-access.md @@ -26,7 +26,7 @@ Also reports: |---|---| |Context|everywhere| |Tags|`@access`| -|Recommended|false| +|Recommended|true| |Settings|| |Options|| diff --git a/docs/rules/lines-before-block.md b/docs/rules/lines-before-block.md index 28d1f57d..f8465d0a 100644 --- a/docs/rules/lines-before-block.md +++ b/docs/rules/lines-before-block.md @@ -34,7 +34,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/docs/rules/no-defaults.md b/docs/rules/no-defaults.md index 7d0cdcdc..b3d2e518 100644 --- a/docs/rules/no-defaults.md +++ b/docs/rules/no-defaults.md @@ -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|false| +|Recommended|true| |Options|`contexts`, `noOptionalParamNames`| diff --git a/docs/rules/require-asterisk-prefix.md b/docs/rules/require-asterisk-prefix.md index baf6d9ea..efde08a3 100644 --- a/docs/rules/require-asterisk-prefix.md +++ b/docs/rules/require-asterisk-prefix.md @@ -53,6 +53,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`| diff --git a/docs/rules/require-template.md b/docs/rules/require-template.md index e968bc2c..7abd16db 100644 --- a/docs/rules/require-template.md +++ b/docs/rules/require-template.md @@ -48,7 +48,7 @@ Defaults to `false`. |---|---| |Context|everywhere| |Tags|`template`| -|Recommended|true| +|Recommended|false| |Settings|| |Options|`requireSeparateTemplates`| diff --git a/docs/rules/require-throws.md b/docs/rules/require-throws.md index d81ceba5..29086671 100644 --- a/docs/rules/require-throws.md +++ b/docs/rules/require-throws.md @@ -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|true| +|Recommended|false| | Options |`contexts`, `exemptedBy`| | Settings | `ignoreReplacesDocs`, `overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs` |