Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dckc opened this issue Mar 26, 2024 · 1 comment
Open

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

dckc opened this issue Mar 26, 2024 · 1 comment
Assignees
Labels
bug Something isn't working devex developer experience documentation Improvements or additions to documentation project Issues submitted for attention of project management at Agoric to communicate with stake-holders

Comments

@dckc
Copy link
Collaborator

dckc commented Mar 26, 2024

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...

* assert that expr is truthy, with an optional details to describe
* the assertion. It is a tagged template literal like
* ```js
* assert(expr, details`....`);`
* ```

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

Additional context

@dckc dckc added bug Something isn't working documentation Improvements or additions to documentation devex developer experience labels Mar 26, 2024
@kriskowal kriskowal self-assigned this Apr 3, 2024
@kriskowal kriskowal added the project Issues submitted for attention of project management at Agoric to communicate with stake-holders label Apr 3, 2024
@kriskowal
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working devex developer experience documentation Improvements or additions to documentation project Issues submitted for attention of project management at Agoric to communicate with stake-holders
Projects
None yet
Development

No branches or pull requests

2 participants