Skip to content

Commit 2df43ce

Browse files
committed
docs(check-alignment, require-jsdoc): incomplete info on contexts
1 parent cf44628 commit 2df43ce

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

.README/rules/check-alignment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Reports invalid alignment of JSDoc block asterisks.
44

55
|||
66
|---|---|
7-
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
7+
|Context|everywhere|
88
|Tags|N/A|
99

1010
<!-- assertions checkAlignment -->

.README/rules/require-jsdoc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Accepts one optional options object with the following optional keys.
4242

4343
|||
4444
|---|---|
45-
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|
45+
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
4646
|Tags|N/A|
4747
|Options|`publicOnly`, `require`, `contexts`, `exemptEmptyFunctions`|
4848

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ Reports invalid alignment of JSDoc block asterisks.
328328

329329
|||
330330
|---|---|
331-
|Context|`ArrowFunctionExpression`, `FunctionDeclaration`, `FunctionExpression`|
331+
|Context|everywhere|
332332
|Tags|N/A|
333333

334334
The following patterns are considered problems:
@@ -5044,7 +5044,7 @@ Accepts one optional options object with the following optional keys.
50445044

50455045
|||
50465046
|---|---|
5047-
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|
5047+
|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`; others when `contexts` option enabled|
50485048
|Tags|N/A|
50495049
|Options|`publicOnly`, `require`, `contexts`, `exemptEmptyFunctions`|
50505050

0 commit comments

Comments
 (0)