search

endojs / endo

Endo is a distributed secure JavaScript sandbox, based on SES
Apache License 2.0
788 stars 70 forks source link

arrow function jsdoc missing in IDE #2178

Open dckc opened 4 months ago

dckc commented 4 months ago

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.

I'm working on reference documentation

turadg commented 4 months ago

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