endojs / endo

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

ses assert docs don't show via typedoc, IDE #2183

Open dckc opened 4 months ago

dckc commented 4 months ago

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

kriskowal commented 4 months ago

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