Skip to content

Commit 4fce006

Browse files
committed
docs: grammar nits
1 parent 00ad476 commit 4fce006

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

.README/rules/require-param-description.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### `require-param-description`
22

3-
Requires that `@param` tag has `description` value.
3+
Requires that each `@param` tag has a `description` value.
44

55
|||
66
|---|---|

.README/rules/require-param-name.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### `require-param-name`
22

3-
Requires that all function parameters have name.
3+
Requires that all function parameters have names.
44

55
> The `@param` tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.
66
>

.README/rules/require-param-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### `require-param-type`
22

3-
Requires that `@param` tag has `type` value.
3+
Requires that each `@param` tag has a `type` value.
44

55
|||
66
|---|---|

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7248,7 +7248,7 @@ export default class Foo {
72487248
<a name="eslint-plugin-jsdoc-rules-require-param-description"></a>
72497249
### <code>require-param-description</code>
72507250
7251-
Requires that `@param` tag has `description` value.
7251+
Requires that each `@param` tag has a `description` value.
72527252
72537253
|||
72547254
|---|---|
@@ -7308,7 +7308,7 @@ function quux (foo) {
73087308
<a name="eslint-plugin-jsdoc-rules-require-param-name"></a>
73097309
### <code>require-param-name</code>
73107310
7311-
Requires that all function parameters have name.
7311+
Requires that all function parameters have names.
73127312
73137313
> The `@param` tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.
73147314
>
@@ -7371,7 +7371,7 @@ function quux (foo) {
73717371
<a name="eslint-plugin-jsdoc-rules-require-param-type"></a>
73727372
### <code>require-param-type</code>
73737373
7374-
Requires that `@param` tag has `type` value.
7374+
Requires that each `@param` tag has a `type` value.
73757375
73767376
|||
73777377
|---|---|

0 commit comments

Comments
 (0)