JSDoc redefines Amount, Brand, ... - Githubissues

Agoric / ui-kit

Components and tools for building graphical UIs

https://ui-kit-dwm.pages.dev/

Apache License 2.0

3 stars 3 forks source link

JSDoc redefines Amount, Brand, ... #103

Closed dckc closed 2 months ago

dckc commented 3 months ago

Describe the bug

generated docs show Amount, Brand and such as if defined in the web-components package.

To Reproduce

Steps to reproduce the behavior:

yarn; yarn docs
open api-docs/index.html
open web-components
See Amount, Brand, ...

Expected behavior

ideally, those types should link to the respective types in https://agoric-sdk.pages.dev/modules/_agoric_ertp ... but... hm... those seem to be missing :-/

Platform Environment

what OS are you using? what version of Node.js?
is there anything special/unusual about your platform?
what version of the Agoric-SDK are you using? (run git describe --tags --always)

Additional context

https://github.com/Agoric/ui-kit/blob/216cc5b36e624d61740a72cbea1c41e9039eed51/packages/web-components/src/display/display.js#L10-L13

The new @import stuff would probably help.

Screenshots

cc @turadg @samsiegart

turadg commented 3 months ago

@samsiegart I tried TS 5.5 (nightly) and it hit some error parsing a cosmjs file. Same error in 5.4.

I think a higher value approach would be to move to .ts syntax here