Skip to content

Commit 215fc28

Browse files
committed
docs(require-returns-check): update docs
1 parent a87ed9e commit 215fc28

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.README/rules/require-returns-check.md

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

3-
Checks if the return expression exists in function body and in the comment.
3+
Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.
44

55
Will also report if multiple `@returns` tags are present.
66

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6320,7 +6320,7 @@ function assign({name, department}) {
63206320
<a name="eslint-plugin-jsdoc-rules-require-returns-check"></a>
63216321
### <code>require-returns-check</code>
63226322

6323-
Checks if the return expression exists in function body and in the comment.
6323+
Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.
63246324

63256325
Will also report if multiple `@returns` tags are present.
63266326

0 commit comments

Comments
 (0)