The jsdoc comments in this package make heavy use of the {@link ...} feature. Unfortunately general support for this has been a longstanding wish list item for the TypeScript and VSCode teams, and there are problems implementing it as everyone would like. The results generated today for our jsdoc comments are not pretty.
It might be good to provide a summary and separate details section, especially for some of the longer comments.
This tooltip screenshot demonstrates both problems:
For reference, an example of how a tooltip for a well-known function (Array#slice) appears:
This issue stands as a placeholder to provide at least some sort of workaround. For #1, it might be as simple as substituting markdown code formatting for the {@link...} instances.
The jsdoc comments in this package make heavy use of the
{@link ...}feature. Unfortunately general support for this has been a longstanding wish list item for the TypeScript and VSCode teams, and there are problems implementing it as everyone would like. The results generated today for our jsdoc comments are not pretty.It might be good to provide a summary and separate details section, especially for some of the longer comments.
This tooltip screenshot demonstrates both problems:
For reference, an example of how a tooltip for a well-known function (Array#slice) appears:
This issue stands as a placeholder to provide at least some sort of workaround. For #1, it might be as simple as substituting markdown
codeformatting for the {@link...} instances.