Skip to content

Improve rendering of JSDoc comment text with displayparts #43085

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.

Sign up for GitHub

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

Jump to bottom
Closed
sandersn opened this issue Mar 4, 2021 · 2 comments · Fixed by #43390
Closed

Improve rendering of JSDoc comment text with displayparts #43085

sandersn opened this issue Mar 4, 2021 · 2 comments · Fixed by #43390
Labels
Experience Enhancement Noncontroversial enhancements Good First Issue Well scoped, documented and has the green light Help Wanted You can do this
Milestone
Backlog

Comments

@sandersn
Copy link
Member

sandersn commented Mar 4, 2021 •
edited
Loading

#41877 improves parsing of jsdoc comment text as well as giving the language service the option of providing display parts for comments instead of text. Currently everything is just "text" except for links. However, with small tweaks to code like getCommentDisplayParts in services/jsDoc.ts, it would be possible to format @param names as "parameterName", @template names as "typeParameterName", etc.

This could make display a lot prettier.

Note: depends on #41877 being merged.
@sandersn sandersn added Experience Enhancement Noncontroversial enhancements Good First Issue Well scoped, documented and has the green light labels Mar 4, 2021
@sandersn sandersn added this to the Backlog milestone Mar 4, 2021
@sandersn sandersn added the Help Wanted You can do this label Mar 4, 2021
@sandersn sandersn mentioned this issue Mar 4, 2021
Merged
@sangxxh
Copy link
Contributor

sangxxh commented Mar 5, 2021

I'd like to work on this issue, I'll watch for when #41877 is merged

@sangxxh
Copy link
Contributor

sangxxh commented Mar 22, 2021

Now awaiting #43312

@sangxxh sangxxh mentioned this issue Mar 26, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Experience Enhancement Noncontroversial enhancements Good First Issue Well scoped, documented and has the green light Help Wanted You can do this
Projects
None yet
Milestone
Backlog
Development

Successfully merging a pull request may close this issue.

Improve rendering of JSDoc comment text with displayparts
2 participants
@sandersn @sangxxh