Improve Hover markdown on 'await' keyword #70629
Conversation
dotnet-issue-labeler
bot
added
Area-IDE
untriaged
| @@ -844,40 +846,65 @@ public static LSP.MarkupContent GetDocumentationMarkupContent(ImmutableArray<Tag | |||
| }; | |||
| } | |||
|
|
|||
| var builder = new StringBuilder(); | |||
| var isInCodeBlock = false; | |||
| using var markdownBuilder = new MarkdownContentBuilder(); | |||
There was a problem hiding this comment.
switched to a more manual builder so I can access the contents of lines
src/Features/LanguageServer/ProtocolUnitTests/Hover/HoverTests.cs
Outdated
Show resolved
Hide resolved
| _linesBuilder = ArrayBuilder<string>.GetInstance(); | ||
| } | ||
|
|
||
| public void Append(string text) |
There was a problem hiding this comment.
Could text every contain embedded newlines?
There was a problem hiding this comment.
Ideally it wouldn't be called like that, but I'm also not sure how to enforce that.
src/Features/LanguageServer/Protocol/Extensions/ProtocolConversions.MarkdownContentBuilder.cs
Outdated
Show resolved
Hide resolved
|
What about "returns System.String"? It's |
So how this works is it actually just wraps the main description info from the symbol being returned. So it has 'class' in there because it just wraps the main description for string: Unfortunately I don't think there is an easy way to remove 'class' without changing where we acquire the text for the return type. So it'd be a bit more of an involved change. |
|
/azp run roslyn-integration-CI |
|
Azure Pipelines successfully started running 1 pipeline(s). |
src/Features/LanguageServer/Protocol/Extensions/ProtocolConversions.MarkdownContentBuilder.cs
Outdated
Show resolved
Hide resolved
src/Features/LanguageServer/Protocol/Extensions/ProtocolConversions.MarkdownContentBuilder.cs
Outdated
Show resolved
Hide resolved
src/Features/LanguageServer/Protocol/Extensions/ProtocolConversions.MarkdownContentBuilder.cs
Outdated
Show resolved
Hide resolved
src/Features/LanguageServer/Protocol/Extensions/ProtocolConversions.MarkdownContentBuilder.cs
Outdated
Show resolved
Hide resolved
Let's open a request on htat as well :) |
ghost
added this to the 
TBH the very idea of specifying a language as a markdown parameter is agains the whole language server idea since it requires client to know what language it is and how to colorize it. It would be perfect if LSP protocol allowed arbitrary colorizations and structuring in hovers similar to VS's hover API (colorized text runs and so on), but considering the speed of LSP development (or its absence) this will probably be added only in a very distant future( |
Improve the appearance of hover on await with return by using an inline code fence.
Resolves dotnet/vscode-csharp#6577
This is not perfect - unfortunately VSCode / markdown doesn't allow us to specify a language name for inline code fences, so it is not colorized. The alternative is to modify this to be a code block on a new line, but that doesn't look great either. This approach seemed reasonable to me.
Now looks like
