Skip to content

Incorrect markdown escaping in completion documentation #8204

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
dibarbet opened this issue Apr 23, 2025 · 0 comments · Fixed by dotnet/roslyn#78405
Closed

Incorrect markdown escaping in completion documentation #8204

dibarbet opened this issue Apr 23, 2025 · 0 comments · Fixed by dotnet/roslyn#78405
Assignees
Milestone

Comments

@dibarbet
Copy link
Member

Image

@dibarbet dibarbet added the Bug label Apr 23, 2025
@dibarbet dibarbet added this to the May2025 milestone Apr 23, 2025
@dibarbet dibarbet self-assigned this Apr 23, 2025
@dibarbet dibarbet changed the title Incorrect markdown escaping in signature help Incorrect markdown escaping in completion documentation Apr 23, 2025
dibarbet added a commit to dotnet/roslyn that referenced this issue May 3, 2025
…s for indentation (#78405)

Resolves dotnet/vscode-csharp#8204

Supported platform information uses 4 spaces in its resource string `
{0} - {1}` for indentation in tool tips. However, 4 spaces at the
beginning of the line in markdown indicates a code block, breaking the
rendering of the supported platform info in LSP (thanks to @JoeRobich
for spotting that!)

Since the 4 spaces are intended to be structural indentation, we need to
use non breaking spaces (`&nbsp`) in markdown. We already handle that
generally when we see a `TextTags.Space` kind. However in this case the
4 spaces were combined with the rest of the string and therefore tagged
as `Text` instead of `Space`

The fix is to separate out the structural spacing from the rest of the
string, and tag it as such. This lets our existing handling of spaces
convert to non breaking spaces when it needs to.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant