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

[luabud]

Discussed in #2648

^{Originally posted by Diogo-Rossi September 10, 2021}

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

[rchiodo]

This issue has been fixed in prerelease version 2024.6.100, which we've just released. You can find the changelog here: CHANGELOG.md

[rchiodo]

The fix for this issue is behind an experimental feature flag:

"python.analysis.supportRestructuredText": true

If you want to try out our new restructuredText support, enable this flag. It's behind a flag at the moment until we can make sure it handles all the possible Sphinx/GoogleDoc/Epytext scenarios that customers need. Please log additional issues if this setting isn't working out for you.

Thanks :)