From 8911ba89a1669796b6e09e90e24bb4f4c7b33697 Mon Sep 17 00:00:00 2001 From: "Mark S. Miller" Date: Sun, 5 May 2024 02:43:53 -0400 Subject: [PATCH] fix(pass-style): remove redundant vestigial @returns declaration (#1958) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- packages/pass-style/src/remotable.js | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/pass-style/src/remotable.js b/packages/pass-style/src/remotable.js index 0a4584f8b4..788ae19d12 100644 --- a/packages/pass-style/src/remotable.js +++ b/packages/pass-style/src/remotable.js @@ -164,12 +164,13 @@ const checkRemotable = (val, check) => { }; /** - * Simple semantics, just tell what interface (or undefined) a remotable has. + * Simple semantics, just tell what interface spec a Remotable has, + * or undefined if not deemed to be a Remotable. + * * @type {{ * (val: PassStyled): T; - * (val: any): string | undefined; + * (val: any): InterfaceSpec | undefined; * }} - * @returns the interface specification, or undefined if not a deemed to be a Remotable */ export const getInterfaceOf = val => { if (