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

endojs / endo

Endo is a distributed secure JavaScript sandbox, based on SES

Apache License 2.0

804 stars 71 forks source link

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

Closed erights closed 4 months ago

erights commented 8 months ago

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 commented 4 months ago

@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.