Skip to content

@see tag doesn't render the entity it refers to #40453

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

Closed
sandersn opened this issue Sep 9, 2020 · 1 comment · Fixed by #40458
Closed

@see tag doesn't render the entity it refers to #40453

sandersn opened this issue Sep 9, 2020 · 1 comment · Fixed by #40458
Assignees
Labels
Fix Available A PR has been opened for this issue

Comments

@sandersn
Copy link
Member

sandersn commented Sep 9, 2020

#39760 just went in, but doesn't render the new tag to quick info correctly.

Code

/** @see x it is cool */
const y = 1

Expected behavior:
Quick info renders "@see x — it is cool"

Actual behavior:

Quick info renders "@see — it is cool"

@sandersn sandersn self-assigned this Sep 9, 2020
@sandersn
Copy link
Member Author

sandersn commented Sep 9, 2020

@Kingwl we forgot to test the quick info rendering -- since the entity name is no longer part of the comment text, it doesn't render anymore.

@sandersn sandersn added this to the TypeScript 4.1.0 milestone Sep 9, 2020
@typescript-bot typescript-bot added the Fix Available A PR has been opened for this issue label Sep 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Fix Available A PR has been opened for this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants