Skip to content

Commit 01d3969

Browse files
committed
docs(require-description, require-example, require-param, require-returns): add reference to potentially applicable settings, removing reference to deprecated items
1 parent 82be5a6 commit 01d3969

File tree

5 files changed

+8
-2
lines changed

5 files changed

+8
-2
lines changed

.README/rules/require-description.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ An options object may have any of the following properties:
2121
|Tags|`description`|
2222
|Aliases|`desc`|
2323
|Options|`contexts`, `exemptedBy`|
24+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
2425

2526
<!-- assertions requireDescription -->

.README/rules/require-example.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,6 @@ This rule has an object option:
2121
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
2222
|Tags|`example`|
2323
|Options|`exemptedBy`, `avoidExampleOnConstructors`|
24+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
2425

2526
<!-- assertions requireExample -->

.README/rules/require-param.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ An options object accepts one optional property:
1515
|Tags|`param`|
1616
|Aliases|`arg`, `argument`|
1717
|Options|`exemptedBy`|
18-
|Settings|`allowOverrideWithoutParam`, `allowImplementsWithoutParam`, `allowAugmentsExtendsWithoutParam`|
18+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
1919

2020
<!-- assertions requireParam -->

.README/rules/require-returns.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ Requires returns are documented.
2222
|Tags|`returns`|
2323
|Aliases|`return`|
2424
|Options|`exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`|
25+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
2526

2627
<!-- assertions requireReturns -->

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3721,6 +3721,7 @@ An options object may have any of the following properties:
37213721
|Tags|`description`|
37223722
|Aliases|`desc`|
37233723
|Options|`contexts`, `exemptedBy`|
3724+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
37243725

37253726
The following patterns are considered problems:
37263727

@@ -3915,6 +3916,7 @@ This rule has an object option:
39153916
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
39163917
|Tags|`example`|
39173918
|Options|`exemptedBy`, `avoidExampleOnConstructors`|
3919+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
39183920

39193921
The following patterns are considered problems:
39203922

@@ -5204,7 +5206,7 @@ An options object accepts one optional property:
52045206
|Tags|`param`|
52055207
|Aliases|`arg`, `argument`|
52065208
|Options|`exemptedBy`|
5207-
|Settings|`allowOverrideWithoutParam`, `allowImplementsWithoutParam`, `allowAugmentsExtendsWithoutParam`|
5209+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
52085210

52095211
The following patterns are considered problems:
52105212

@@ -6138,6 +6140,7 @@ Requires returns are documented.
61386140
|Tags|`returns`|
61396141
|Aliases|`return`|
61406142
|Options|`exemptedBy`, `forceRequireReturn`, `forceReturnsWithAsync`|
6143+
|Settings|`overrideReplacesDocs`, `augmentsExtendsReplacesDocs`, `implementsReplacesDocs`|
61416144

61426145
The following patterns are considered problems:
61436146

0 commit comments

Comments
 (0)