Intellisense does not show the complete multiline description of function/method parameters

[Diogo-Rossi]

Environment data

• VS Code version: 1.60.0
• Extension version: 2021.9.1218897484
• OS and version: Windows_NT x64 10.0.19043
• Python version: 3.8.8, Anaconda
• Type of virtual environment used: conda
• Relevant/affected Python packages and their versions: none
• Relevant/affected Python-related VS Code extensions and their versions: Pylance 2021.9.1
• Value of the python.languageServer setting: Default

Expected behaviour

Intellisense should show descriptions of function/method parameters of the Docstring as you type then, like the example below.

Actual behaviour

When the descriptions of function/method parameters takes more than one line in the docstring,
the descriptions shows only the first line.

Steps to reproduce:

Write a function like the one show above with multiline parameters descriptions in the docstring, and try to use it,
or try to use a function that already exists.

Here is the snippet, to help:

def foo(a:int,b:float,c:str):
    """
        Parameters
        ----------
            a (int): integer number.
            b (float): description that takes
                more than 1 line in docstr
            c (str): word.
    """
    pass

[jakebailey]

This loose parameter parsing for signature help is one of the older parts of the code, and predates our improved docstring formatting; this could stand to be improved, though I wonder how much it's actually working.

[judej]

Moving this issue to discussion as an enhancement request for comments and upvotes.

[Diogo-Rossi]

Just to give an example. The JavaScript support in VS Code does that very well.

See this example.

/**
 * Takes 2 numbers and return the sum
 * @param {Number} a The first number with very long description in it
 *  taking more than one line in the description
 * @param {Number} b The seconde number.
 * @returns The sum of the two numbers
 */

function sumNumbers(a, b){
    return a + b
}

Calling the function

The parameters

[EdNutting]

My vote: Please fix this. Thanks!