endo icon indicating copy to clipboard operation
endo copied to clipboard

ses assert docs don't show via typedoc, IDE

Open dckc opened this issue 1 year ago • 1 comments

Describe the bug

https://endojs.github.io/endo/modules/ses.html is missing all the prose from https://github.com/endojs/endo/blob/master/packages/ses/src/error/types.js

It's all clobbered by https://github.com/endojs/endo/blob/master/packages/ses/types.d.ts

Expected behavior

When I hover over assert in my IDE, I should see prose such as...

https://github.com/endojs/endo/blob/1813f35432e266a4998c090f32b184b166d5d47f/packages/ses/src/error/types.js#L335-L339

The words in the prose such as "truthy" should also be available via search.

Additional context

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

dckc avatar Mar 26 '24 04:03 dckc

Submitting to @aj-agoric to consider whether this connects to a project priority.

kriskowal avatar Apr 03 '24 03:04 kriskowal