Parameter documentation

Hello,

when I see parameter list, there are only names of parameters - would there be a way to display documentation for them (if present in docstring)? Or better yet, documentation for entire procedure/function? I am looking for a way to do this automatically, after writing left parenthesis. I know I can move the caret to the name of the function and use quick documentation lookup, but that's quite a lot of steps for just seeing parameter descriptions..

Thank you.

3 comments

Hello,

Settings | Editor | Code Completion | Autopopup documentation

when I see parameter list, there are only names of parameters - would

there be a way to display documentation for them (if present in

docstring)? Or better yet, documentation for entire

procedure/function? I am looking for a way to do this automatically,

after writing left parenthesis. I know I can move the caret to the

name of the function and use quick documentation lookup, but that's

quite a lot of steps for just seeing parameter descriptions..

--

Dmitry Jemerov

Development Lead

JetBrains, Inc.

http://www.jetbrains.com/

"Develop with Pleasure!"

0

Thank you for your reply. Unfortunately, this doesn't seem to work for me. I have checked the box it and it still looks the same:

screen1.jpg

The desired behaviour would be something like this:

screen2.jpg

Autopopup documentation seems to display documentation for functions/procedures in autocomplete box. What I meant is to display such information in the box that shows up while passing parameters to function/procedure.



Attachment(s):
screen1.jpg
screen2.jpg
0

If the behavior described in my last post isn't desirable, may I suggest an alternative?

Ctrl-Q (Quick documentation lookup) currently (1.5.4) doesn't work for me when carret is inside the function's parameter brackets. What if it worked here as well? Perhaps only if there has been nothing entered into brackets yet, which shouldn't interfere with the ability to lookup documentation for functions used as parameter.

0

Please sign in to leave a comment.