Skip to content

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

Open
@dckc

Description

@dckc

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

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdevexdeveloper experiencedocumentationImprovements or additions to documentationprojectIssues submitted for attention of project management at Agoric to communicate with stake-holders

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions