Skip to content

CommonMark compliant HTML block inside <p> tag is removed by JSDoc Intellisense #113959

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
trivikr opened this issue Jan 7, 2021 · 4 comments
Closed
Assignees
Labels
*duplicate Issue identified as a duplicate of another issue(s) suggest IntelliSense, Auto Complete typescript Typescript support issues

Comments

@trivikr
Copy link

trivikr commented Jan 7, 2021

  • VSCode Version: 1.52.1
  • OS Version: Darwin x64 19.6.0

Steps to Reproduce:

  1. Open the example code in VSCode.
  2. Hover over Foo. The Tooltip reads "".
  3. Hover over Bar. The Tooltip reads "A basic interface with bar."

The doc comment for Foo is compliant under CommonMark spec 0.29 4.6 HTML Blocks kind 6

  • Start condition: line begins the string < followed by p, followed by the string >
  • End condition: line is followed by a blank line
Example Code
/**
 * <p>A basic interface with foo.</p>
 */
interface Foo {
  foo: number;
}

let f: Foo; // Tooltip reads ""

/**
 * A basic interface with bar.
 */
interface Bar {
  bar: number;
}

let b: Bar; // Tooltip reads "A basic interface with bar."
Screenshots

Screen Shot 2021-01-06 at 10 27 58 PM

Screen Shot 2021-01-06 at 10 28 03 PM

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

@trivikr
Copy link
Author

trivikr commented Jan 7, 2021

A similar issue discusses removal of code inside <pre> and <code> tags in #110945, but that appears under CommonMark spec 0.29 4.5 Fenced code blocks

@trivikr
Copy link
Author

trivikr commented Jan 7, 2021

Looking at the code comments, the makrdownRenderer seems to comply with CommonMark 0.29 spec.

// HTML tags that can result from markdown are from reading https://spec.commonmark.org/0.29/

@trivikr
Copy link
Author

trivikr commented Jan 7, 2021

Some findings which could be helpful:

The Marked Demo returns data as per CommonMark spec 0.29 4.6 HTML Blocks kind 6 for provided example.

Screenshot

Screen Shot 2021-01-07 at 8 33 50 AM

The example is also given in README under CLI usage https://github.com/markedjs/marked#usage

@mjbvz
Copy link
Collaborator

mjbvz commented Jan 7, 2021

Duplicate of #110945 I believe, just with a different html tag

@mjbvz mjbvz closed this as completed Jan 7, 2021
@mjbvz mjbvz added *duplicate Issue identified as a duplicate of another issue(s) suggest IntelliSense, Auto Complete typescript Typescript support issues labels Jan 7, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Feb 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
*duplicate Issue identified as a duplicate of another issue(s) suggest IntelliSense, Auto Complete typescript Typescript support issues
Projects
None yet
Development

No branches or pull requests

3 participants