pylance-release icon indicating copy to clipboard operation
pylance-release copied to clipboard

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

Open luabud opened this issue 2 years ago • 0 comments

Discussed in https://github.com/microsoft/pylance-release/discussions/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.

gif000

Actual behaviour

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

gif001

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

luabud avatar Jun 15 '22 21:06 luabud