Signature Help Documentation is the xml and not human-readable

[zoriya]

The signature help uses the xml data and not the summary tag for the documentation of the signature. The specification wants plain text or markdown instead.

Plain text is already used for parameters documentation, it should be the same everywhere. This issue was already raised during the implementation of Structured here, but it was not modified (I don't know why).

I confirmed that VS Code is not using the documentation field so changing it would not break their implementation, but I don't know about other editors, so should I PR or not?

For now on editors that don't do a custom thing for Roslyn, this is shown instead:

[nickspoons]

We don't use the Documentation property in OmniSharp-vim, we use the StructuredDocumentation.

[JoeRobich]

@AnonymusRaccoon Which OmniSharp host is being used in this scenario? The LSP or STDIO/HTTP? If it is the LSP, then the fix would go in the Handler for the signatureinfo requests.

omnisharp-roslyn/src/OmniSharp.LanguageServerProtocol/Handlers/OmniSharpSignatureHelpHandler.cs

Line 52 in 0208ea2

Documentation = x.Documentation,

[zoriya]

I use the lsp mode, but I think it would be better to return a human readable documentation on this field on every mode, since others fields are made for humans to read.

[JoeRobich]

@AnonymusRaccoon The OmniSharp protocol service doesn't have to return the same values as the LSP. I am not aware of all the tooling that builds on top of O#, but certainly there could be tooling that depends on the current behavior. I do agree the LSP should be updated to set Documentation to be the StructureDocumentation Summary string.

[zoriya]

Okay, I will update the PR accordingly.