Skip to content
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

<> in docstrings gets rendered as &lt;&gt; on hovering over calls #816

Closed
ghost opened this issue Jan 7, 2021 · 1 comment
Closed

<> in docstrings gets rendered as &lt;&gt; on hovering over calls #816

ghost opened this issue Jan 7, 2021 · 1 comment
Labels
bug Something isn't working fixed in next version (main) A fix has been implemented and will appear in an upcoming version

Comments

@ghost
Copy link

ghost commented Jan 7, 2021

Environment data

  • VS Code version:
1.52.1
ea3859d4ba2f3e577a159bc91e3074c5d85c0523
x64
  • Extension version (available under the Extensions sidebar): v2020.12.424452561
  • OS and version: Ubuntu 20.04
  • Python version (& distribution if applicable, e.g. Anaconda): 3.8.5
  • Type of virtual environment used (N/A | venv | virtualenv | conda | ...): venv
  • Value of the python.languageServer setting: Pylance

[NOTE: If you suspect that your issue is related to the Microsoft Python Language Server (python.languageServer: 'Microsoft'), please download our new language server Pylance from the VS Code marketplace to see if that fixes your issue]

Expected behaviour

The docstrings should be rendered correctly.

Actual behaviour

The < and > characters when placed inside code blocks in docstrings get rendered as &lt; and &gt; respectively when moue is hovered over definition of the function (or class) or a call to the function.

Steps to reproduce:

Consider this code:
Screenshot from 2021-01-07 16-58-07

When I hover over the definition, it shows the docstring as:
Screenshot from 2021-01-07 16-59-38

I don't think it was supposed to be this way and it must be something with this extension because this doesn't happen with other languages.

@karthiknadig karthiknadig transferred this issue from microsoft/vscode-python Jan 7, 2021
@github-actions github-actions bot added the triage label Jan 7, 2021
@judej judej added the bug Something isn't working label Jan 7, 2021
@github-actions github-actions bot removed the triage label Jan 7, 2021
@bschnurr bschnurr closed this as completed Mar 9, 2021
@bschnurr bschnurr reopened this Mar 9, 2021
@jakebailey jakebailey added the fixed in next version (main) A fix has been implemented and will appear in an upcoming version label Mar 9, 2021
@jakebailey
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fixed in next version (main) A fix has been implemented and will appear in an upcoming version
Projects
None yet
Development

No branches or pull requests

4 participants