You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
jsdoc/require-returns should not emit a warning because the return type is Promise<void>.
Actual behavior
1:1 warning Missing JSDoc @returns declaration jsdoc/require-returns.
Happens even if the function is declared async explicitly. Without the <void>, the return type is inferred to be Promise<unknown> in which case the warning makes sense. Is this type knowledge lost to jsdoc in this case?
This PR contains the following updates:
| Package | Type | Update | Change |
|---|---|---|---|
| [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | devDependencies | patch | [`37.9.4` -> `37.9.5`](https://renovatebot.com/diffs/npm/eslint-plugin-jsdoc/37.9.4/37.9.5) |
---
### Release Notes
<details>
<summary>gajus/eslint-plugin-jsdoc</summary>
### [`v37.9.5`](https://github.com/gajus/eslint-plugin-jsdoc/releases/v37.9.5)
[Compare Source](gajus/eslint-plugin-jsdoc@v37.9.4...v37.9.5)
##### Bug Fixes
- stop reporting `async` function (unless with `forceReturnsWithAsync`) or Promise return with void type parameter; fixes [#​845](gajus/eslint-plugin-jsdoc#845) ([509baf9](gajus/eslint-plugin-jsdoc@509baf9))
</details>
---
### Configuration
📅 **Schedule**: At any time (no schedule defined).
🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.
♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 **Ignore**: Close this PR and you won't be reminded about this update again.
---
- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.
---
This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1191
Reviewed-by: 6543 <6543@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Expected behavior
jsdoc/require-returns
should not emit a warning because the return type isPromise<void>
.Actual behavior
1:1 warning Missing JSDoc @returns declaration jsdoc/require-returns
.Happens even if the function is declared
async
explicitly. Without the<void>
, the return type is inferred to bePromise<unknown>
in which case the warning makes sense. Is this type knowledge lost to jsdoc in this case?ESLint Config
ESLint sample
The warning can be fixed by adding
@returns nothing
to the jsdoc above.Environment
14.18.1
8.10.0
eslint-plugin-jsdoc
version:37.9.4
The text was updated successfully, but these errors were encountered: