fix(pass-style): remove redundant vestigial @returns declaration#1958
Merged
fix(pass-style): remove redundant vestigial @returns declaration#1958
Conversation
218374a to
9c53349
Compare
turadg
approved these changes
Jan 11, 2024
Member
turadg
left a comment
There was a problem hiding this comment.
I'd suggest removing the jsdoc/require-returns-type rule, since it is legitimate to define a type for the return and separately a JSDoc describing it.
9c53349 to
9adce53
Compare
Contributor
Author
|
@turadg , you approved this long ago, but I held it back waiting for endo typing to settle down. Which it has -- thanks! I'm still getting the same warning, and the same fix still seems correct, so I'm merging this. Also, I have not done anything about the Letting you know because so much has changed since then, even though this still seems good as is. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes: #XXXX
refs: #1933
Description
The declaration site had both a correct @type declaration and a redundant vestigial partial @returns declaration. Because the latter also was not properly formed, it caused the warning
This PR removes it, and does a bit of trivial polishing of the remainder.
Security Considerations
none
Scaling Considerations
none
Documentation Considerations
more accurate type declarations should eventually help documentation
Testing Considerations
none
Upgrade Considerations
none