Docstrings

[Samrose-Ahmed]

Release mentioned docstring support. Couldn't find anything.

How do you use it?

[erictraut]

Docstrings for modules, classes, functions, methods and properties will appear in hover text (when you hover over a symbol), in signature help (the text that appears when you're typing a call expression to help you fill in the correct arguments), and in completion suggestions (as you scroll through the list of suggested completions that are provided when you type).

[heejaechang]

FYI, you can see docstrings shows up, completion, signature help, hover

[Destaq]

@heejaechang This does not seem to be working for me - I tried writing the exact same code as you, but nothing showed up.

[heejaechang]

so, I see signature help shows doc string. since you didn't try hover, I am not sure about hover. so I guess you are talking about completion?

for completion tooltip, can you give a pause after typing T or meth so that vscode doesn't cancel tooltip out before it showing it?

[Destaq]

@heejaechang Yes I'm interested in the completion, that is the #1 feature for me. In your video that you posted, it seemed like it worked completely for you (see below):

Hovering does work for me. However, what I am interested in is the second box to the side of the completion list that describes the docstring.

When I run it as so:

I do not get any completion.

[jakebailey]

You have it hidden in VS Code.

Hit Ctrl+Space when the tooltip is open, or hover over the completion item and click the "(i)" icon on the right (which appears when you hover).

[Destaq]

Thank you! That did the trick - I must have had it off by default for VS Code, and I have never had access to that second box before. This works now.

[jakebailey]

It stays open if you open it once, until you repeat the step again to disable it. This is a VS Code behavior, you probably want to ask them to allow it to never be hidden.

I don't know what the key combo is on Mac, but the hover and click method will work to enable it.

[jakebailey]

Thanks for confirming!