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

TSDoc @example tag is improperly handled in previews #132820

Closed
Gerrit0 opened this issue Sep 10, 2021 · 0 comments · Fixed by #132821
Closed

TSDoc @example tag is improperly handled in previews #132820

Gerrit0 opened this issue Sep 10, 2021 · 0 comments · Fixed by #132821
Assignees
Labels
bug Issue identified by VS Code Team member as probable bug insiders-released Patch has been released in VS Code Insiders verified Verification succeeded
Milestone

Comments

@Gerrit0
Copy link
Contributor

Gerrit0 commented Sep 10, 2021

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version: f7bdb7c
  • OS Version: All

Steps to Reproduce:

  1. Create a TypeScript file with the following valid TSDoc content:
    /**
     * @example
     * TSDoc-like example tag
     * ```js
     * void foo();
     * ```
     */
    function test() {
        //
    }
  2. Hover over the declaration for test
    image

This should be handled in the same way as if the text was wrapped in <caption> as required by JSDoc

/**
 * @example <caption>TSDoc-like example tag</caption>
 * ```js
 * void foo();
 * ```
 */
function test() {
    //
}

image

@mjbvz mjbvz added the bug Issue identified by VS Code Team member as probable bug label Sep 10, 2021
@mjbvz mjbvz added this to the October 2021 milestone Oct 7, 2021
@jrieken jrieken added the verified Verification succeeded label Oct 26, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Nov 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Issue identified by VS Code Team member as probable bug insiders-released Patch has been released in VS Code Insiders verified Verification succeeded
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants
@jrieken @mjbvz @Gerrit0 and others