Skip to content

Commit 21b28ae

Browse files
jens-duttkechiawendt
authored andcommitted
docs(require-returns): Fix typo
1 parent d4b9218 commit 21b28ae

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
@@ -15,7 +15,7 @@ Will also report if multiple `@returns` tags are present.
1515
- `forceReturnsWithAsync` - By default `async` functions that do not explicitly return a value pass this rule. You can force all `async` functions to require return statements by setting `forceReturnsWithAsync` to `true` on the options object. This may be useful as an `async` function will always return a `Promise`, even if the `Promise` returns void. Defaults to `false`.
1616

1717
```js
18-
'jsdoc/require-jsdoc': ['error', {forceReturnsWithAsync: true}]
18+
'jsdoc/require-returns': ['error', {forceReturnsWithAsync: true}]
1919
```
2020

2121
|||

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6868,7 +6868,7 @@ Will also report if multiple `@returns` tags are present.
68686868
- `forceReturnsWithAsync` - By default `async` functions that do not explicitly return a value pass this rule. You can force all `async` functions to require return statements by setting `forceReturnsWithAsync` to `true` on the options object. This may be useful as an `async` function will always return a `Promise`, even if the `Promise` returns void. Defaults to `false`.
68696869

68706870
```js
6871-
'jsdoc/require-jsdoc': ['error', {forceReturnsWithAsync: true}]
6871+
'jsdoc/require-returns': ['error', {forceReturnsWithAsync: true}]
68726872
```
68736873

68746874
|||

0 commit comments

Comments
 (0)