Skip to content

Commit

Permalink
fix(pass-style): remove redundant vestigial @returns declaration (#1958)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
erights committed May 5, 2024
1 parent 334b016 commit 8911ba8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions packages/pass-style/src/remotable.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {{
* <T extends string>(val: PassStyled<any, T>): 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 (
Expand Down

0 comments on commit 8911ba8

Please sign in to comment.