Completion documentation strings sometimes being formatted as code

[jakebailey]

The function signature and docstring are getting mixed together, so the actual text bit is getting syntax formatted. For example:

This only happens with completion, as I can hover and see:

Where the docstring isn't being treated that way.

[jakebailey]

And just to check, I went back to before my plaintext-as-default fix, and that didn't seem to matter.

The code that generates the completion content and the hover content is different, so the completion part may need fixing.

[MikhailArkhipov]

It is VS Code issue. You can observe similar effect in C#. We actually DO terminate code block with signature (bounded by triple-ticks) but VS Code leaks formatting into the subsequent code. I opened microsoft/vscode#49018 long time ago, but it did not repro in a simple case. Or maybe not use html as a language for preformatted block.

[jakebailey]

Interestingly, if I copy some of the hover code and forcibly call RestTextConverter.ToMarkdown on the doc (even through it's already markdown), I get something slightly better:

From the debugger I can see it adding HTML style line breaks, which seem to work for some reason. The original string that would have been returned does appear to be as you describe. Weird.

(Mind you that RestTextConverter would have already been called, so it's basically being called twice...)

[jakebailey]

As of #596 and other tooltip changes, this should no longer be the case.