endo icon indicating copy to clipboard operation
endo copied to clipboard

arrow function jsdoc missing in IDE

Open dckc opened this issue 1 year ago • 1 comments

Describe the bug

compare jsdoc in the code:

https://github.com/endojs/endo/blob/39b85998b41fc2e7adfa3f72a7d03c110cb1a9f0/packages/pass-style/src/make-far.js#L166-L178

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.

  • https://github.com/Agoric/agoric-sdk/issues/9136

I'm working on reference documentation

  • https://github.com/Agoric/documentation/issues/1031

dckc avatar Mar 25 '24 18:03 dckc

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

  • https://github.com/microsoft/TypeScript/issues/34860

turadg avatar Mar 25 '24 21:03 turadg