Skip to content

Commit 9b85d7e

Browse files
committed
docs(require-returns): clarify that option forces async functions to require @returns documentation, not return statements
1 parent c0ae4cb commit 9b85d7e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.README/rules/require-returns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Will also report if multiple `@returns` tags are present.
2222
- `forceReturnsWithAsync` - By default `async` functions that do not explicitly
2323
return a value pass this rule as an `async` function will always return a
2424
`Promise`, even if the `Promise` resolves to void. You can force all
25-
`async` functions to require return statements by setting
25+
`async` functions to require `@return` documentation by setting
2626
`forceReturnsWithAsync` to `true` on the options object. This may be useful
2727
for flagging that there has been consideration of return type. Defaults
2828
to `false`.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14435,7 +14435,7 @@ Will also report if multiple `@returns` tags are present.
1443514435
- `forceReturnsWithAsync` - By default `async` functions that do not explicitly
1443614436
return a value pass this rule as an `async` function will always return a
1443714437
`Promise`, even if the `Promise` resolves to void. You can force all
14438-
`async` functions to require return statements by setting
14438+
`async` functions to require `@return` documentation by setting
1443914439
`forceReturnsWithAsync` to `true` on the options object. This may be useful
1444014440
for flagging that there has been consideration of return type. Defaults
1444114441
to `false`.

0 commit comments

Comments
 (0)