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

[BUG] Backticks in doc comments are not escaped when converting to markdown for quick info. #1499

Closed
mhutch opened this issue Sep 30, 2024 · 1 comment · Fixed by dotnet/roslyn#75364
Labels
area-roslyn bug Something isn't working

Comments

@mhutch
Copy link
Member

mhutch commented Sep 30, 2024

Describe the Issue

I have a doc comment that contains a <c> code span with backtick: <c>A`1[B,C]</c>

When the LSP converts the doc comment to markdown for the quick info, it does not appear to be escaping the backtick, resulting in malformed output:

Screenshot 2024-09-30 at 12 00 12 PM

Steps To Reproduce

  1. Create a member with a doc comment summary that contains <c>A`1[B,C]</c>
  2. Hover over the member and look at the quick info
  3. It is rendered as follows: A1[B,C]`

Expected Behavior

It is rendered as A`1[B,C]

Environment Information

No response

@JoeRobich
Copy link
Member

Thank @mhutch! The fix should be in the next prerelease.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-roslyn bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants