Intellisense does not show the complete multiline description of function/method parameters #2648
Replies: 4 comments
-
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. |
Beta Was this translation helpful? Give feedback.
-
Moving this issue to discussion as an enhancement request for comments and upvotes. |
Beta Was this translation helpful? Give feedback.
-
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 functionThe parameters |
Beta Was this translation helpful? Give feedback.
-
My vote: Please fix this. Thanks! |
Beta Was this translation helpful? Give feedback.
-
Environment data
python.languageServer
setting: DefaultExpected 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:
Beta Was this translation helpful? Give feedback.
All reactions