Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(pass-style): remove redundant vestigial @returns declaration #1958

Merged
merged 1 commit into from
May 5, 2024

Conversation

erights
Copy link
Contributor

@erights erights commented Jan 11, 2024

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

.../endojs/endo/packages/pass-style/src/remotable.js
  175:1  warning  Missing JSDoc @returns type  jsdoc/require-returns-type

✖ 1 problem (0 errors, 1 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

@erights erights requested a review from turadg January 11, 2024 04:58
@erights erights self-assigned this Jan 11, 2024
@erights erights force-pushed the markm-remove-redundant-vestigial-declaration branch from 218374a to 9c53349 Compare January 11, 2024 05:00
Copy link
Member

@turadg turadg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@erights erights force-pushed the markm-remove-redundant-vestigial-declaration branch from 9c53349 to 9adce53 Compare May 5, 2024 06:36
@erights
Copy link
Contributor Author

erights commented May 5, 2024

@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 jsdoc/require-returns-type that you suggest removing.

Letting you know because so much has changed since then, even though this still seems good as is.

@erights erights enabled auto-merge (squash) May 5, 2024 06:41
@erights erights merged commit 8911ba8 into master May 5, 2024
17 checks passed
@erights erights deleted the markm-remove-redundant-vestigial-declaration branch May 5, 2024 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants