Skip to content

Commit e60c70f

Browse files
committed
docs(check-param-names): clarify rule description
1 parent 94f784f commit e60c70f

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

.README/rules/check-param-names.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
### `check-param-names`
22

3-
Ensures that parameter names in JSDoc match those in the function declaration.
3+
Ensures that parameter names in JSDoc are matched by corresponding items in
4+
the function declaration.
45

56
#### Destructuring
67

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2788,7 +2788,8 @@ const fn = ( a, b ) => {};
27882788
<a name="eslint-plugin-jsdoc-rules-check-param-names"></a>
27892789
### <code>check-param-names</code>
27902790

2791-
Ensures that parameter names in JSDoc match those in the function declaration.
2791+
Ensures that parameter names in JSDoc are matched by corresponding items in
2792+
the function declaration.
27922793

27932794
<a name="user-content-eslint-plugin-jsdoc-rules-check-param-names-destructuring"></a>
27942795
<a name="eslint-plugin-jsdoc-rules-check-param-names-destructuring"></a>

0 commit comments

Comments
 (0)