Skip to content

Commit 99ce62a

Browse files
brettz9golopot
authored andcommitted
- revert docs to indicate an array of strings is required for contexts rules
1 parent 63e573b commit 99ce62a

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

.README/rules/match-description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ it by setting it to `false`.
7171

7272
##### `contexts`
7373

74-
Set this to a string or array of strings representing the AST context
74+
Set this to an array of strings representing the AST context
7575
where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
7676
Overrides the defaults.
7777

.README/rules/require-description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Requires that all functions have a description.
99

1010
An options object may have any of the following properties:
1111

12-
- `contexts` - Set to a string or array of strings representing the AST context
12+
- `contexts` - Set to an array of strings representing the AST context
1313
where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
1414
Overrides the defaults.
1515
- `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document

.README/rules/require-jsdoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ be checked by the rule.
3434
- `FunctionExpression`
3535
- `MethodDefinition`
3636

37-
- `contexts` - Set this to a string or array of strings representing the additional
37+
- `contexts` - Set this to an array of strings representing the additional
3838
AST context where you wish the rule to be applied (e.g., `Property` for properties).
3939

4040
|||

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2321,7 +2321,7 @@ it by setting it to `false`.
23212321
<a name="eslint-plugin-jsdoc-rules-match-description-options-1-contexts"></a>
23222322
##### <code>contexts</code>
23232323

2324-
Set this to a string or array of strings representing the AST context
2324+
Set this to an array of strings representing the AST context
23252325
where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
23262326
Overrides the defaults.
23272327

@@ -3510,7 +3510,7 @@ Requires that all functions have a description.
35103510

35113511
An options object may have any of the following properties:
35123512

3513-
- `contexts` - Set to a string or array of strings representing the AST context
3513+
- `contexts` - Set to an array of strings representing the AST context
35143514
where you wish the rule to be applied (e.g., `ClassDeclaration` for ES6 classes).
35153515
Overrides the defaults.
35163516
- `exemptedBy` - Array of tags (e.g., `['type']`) whose presence on the document
@@ -3941,7 +3941,7 @@ be checked by the rule.
39413941
- `FunctionExpression`
39423942
- `MethodDefinition`
39433943

3944-
- `contexts` - Set this to a string or array of strings representing the additional
3944+
- `contexts` - Set this to an array of strings representing the additional
39453945
AST context where you wish the rule to be applied (e.g., `Property` for properties).
39463946

39473947
|||

0 commit comments

Comments
 (0)