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

arrow function jsdoc missing in IDE #2178

Open
dckc opened this issue Mar 25, 2024 · 1 comment
Open

arrow function jsdoc missing in IDE #2178

dckc opened this issue Mar 25, 2024 · 1 comment
Labels
devex developer experience documentation Improvements or additions to documentation

Comments

@dckc
Copy link
Collaborator

dckc commented Mar 25, 2024

Describe the bug

compare jsdoc in the code:

/**
* A concise convenience for the most common `Remotable` use.
*
* For far objects (as opposed to far functions), also adds a miranda
* `GET_METHOD_NAMES` method that returns an array of all the method names,
* if there is not yet any method named `GET_METHOD_NAMES`. (Hence "miranda")
*
* @template {{}} T
* @param {string} farName This name will be prepended with `Alleged: `
* for now to form the `Remotable` `iface` argument.
* @param {T} [remotable] The object used as the remotable
*/
export const Far = (farName, remotable = undefined) => {

with IDE experience:

Screenshot at 2024-03-25 13-26-44

The latter is missing the prose from the former.

Steps to reproduce

We can also see that the prose is missing in
https://npmfs.com/package/@endo/pass-style/1.3.0/src/make-far.d.ts

Expected behavior

prose from JSDoc shows up on hover and in make-far.d.ts.

Platform environment

unremarkable, I'm pretty sure

Additional context

@turadg diagnosed the causes as being missing return type annotations lack of support for docstrings on arrow functions.

I'm working on reference documentation

@turadg
Copy link
Member

turadg commented Mar 25, 2024

With some additional debugging we found that problem issue is actually,

@dckc dckc changed the title implicit return type leads to missing jsdoc in IDE arrow function jsdoc missing in IDE Mar 25, 2024
@dckc dckc added documentation Improvements or additions to documentation devex developer experience labels Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devex developer experience documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants