python intelliSence by Pylance not rendered AS IS

[sirlis]

Environment

VSCode Version: 1.51.1
OS Version: windows 10
Python Version: 3.7.9 64-bit

Steps to Reproduce:

• install pylance
• define a class, or import a 3rd party package (e.g. pytorch) and then use a class
• hover your mouse on the class name
• the provided comment doc strings is not rendered AS IS

I'm using VSCode to write python, and using Pylance to provide intelliSence. I think that comment doc strings should be rendered AS IS. No markup interpretation. If the author makes an effort to format the string it look good.

Detailed description

user defined class:

pytorch class:

I tried the - (minus) method and it worked more reasonable than plain text. But I also faced with _ problems in variable names as is shown below. Since I can add --- in my user defined classes, I cannot edit comments in 3rd party packages like PyTorch, whose comments are shown in the images above and are rendered as plain text by Pylance.

[jakebailey]

Not converting to markdown wouldn't be a good idea (as it prevents us from using markdown at all in the tooltips). VS Code's plaintext support is broken until 1.52, but maybe then we could add a toggle to say "use plaintext only".

[savannahostrowski]

This will be fixed in the next version of Pylance!

cc: @bschnurr

[jakebailey]

This issue has been fixed in version 2021.2.0, which we've just released. You can find the changelog here: https://github.com/microsoft/pylance-release/blob/main/CHANGELOG.md#202120-3-february-2021