Bad Formatting in Documentation when Hovering Over a Function Name

[mdko]

• VS Code Version: 1.54.1
• OS Version: macOS 11.2.3

Steps to Reproduce:

1. Given the following documented code:

def foo(a, b):
    """ Do something on a and b
    :param a: the first argument; this one's pretty
        interesting and requires two lines.
    :param b: the second argument
    :return: a + b
    """
    return a + b

hovering over the function will split the description of the a parameter:

2. When I remove the indent preceding "interesting":

def foo(a, b):
    """ Do something on a and b
    :param a: the first argument; this one's pretty
    interesting and requires two lines.
    :param b: the second argument
    :return: a + b
    """
    return a + b

hovering will show this instead:

3. I expect the hover help documentation of parameters/return values with a leading indent (Example 1 above) to treat that indent as a single whitespace (and thus produce something like Example 2 above).

Does this issue occur when all extensions are disabled?: Yes

[mjbvz]

/extPython

[vscode-triage-bot]

It looks like this is caused by the Python extension. Please file it with the repository here. Make sure to check their issue reporting template and provide them relevant information such as the extension version you're using. See also our issue reporting guidelines for more information.

Happy Coding!