docs(check-param-names): clarify rule description

gajus · Oct 27, 2022 · e60c70f · e60c70f
1 parent 94f784f
commit e60c70f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.README/rules/check-param-names.md b/.README/rules/check-param-names.md
@@ -1,6 +1,7 @@
 ### `check-param-names`
 
-Ensures that parameter names in JSDoc match those in the function declaration.
+Ensures that parameter names in JSDoc are matched by corresponding items in
+the function declaration.
 
 #### Destructuring
 

diff --git a/README.md b/README.md
@@ -2788,7 +2788,8 @@ const fn = ( a, b ) => {};
 <a name="eslint-plugin-jsdoc-rules-check-param-names"></a>
 ### <code>check-param-names</code>
 
-Ensures that parameter names in JSDoc match those in the function declaration.
+Ensures that parameter names in JSDoc are matched by corresponding items in
+the function declaration.
 
 <a name="user-content-eslint-plugin-jsdoc-rules-check-param-names-destructuring"></a>
 <a name="eslint-plugin-jsdoc-rules-check-param-names-destructuring"></a>