Show complete documentation in vscode

Viewed 12030

Jupyter Notebook shows the complete documentation on shift + tab. Is there a way I can get the same with vscode?

Ctrl + shift + space only provides methods signature.

Edit: I am hoping to see something like this

enter image description here

6 Answers

I have the same problem. The only solution I found is to use "?" at the end of the function like,

np.random.randint? run

enter image description here

I have recently been trying to get to use VSCode with Jupyter Notebooks as well and for me (on macOS, I assume it would be the same for Windows) all I have to do is hover the mouse on top of the method I wanna get the documentation for and wait a little bit, and it'll pop up.

Please take a look at the image below (since this is my first answer I can't embed the picture, but you should be able to click the link to have a look).

VSCode documentation popup

You could try to use the extension: Pylance.

If you want to view related information, you could find it in the folder under the module that you need to install in the created virtual environment.

For example, using the module 'pandas', you can find file 'parsers.py' in '.venv\Lib\site-packages\pandas\io', which contains relevant parsed content.

enter image description here

Reference: https://marketplace.visualstudio.com/items?itemName=ms-python.python

As Caner Erden pointed out, you can use Pythons base functionality of typing a '?', just make sure you do it before the method, not after.

This will give you the complete documentation you are looking for, just within the code cell, unfortunately not a pop out window like Jupyter Notebook.

Example of documentation in vscode-jupyter

This contextual help issue is being tracked here on vscode-jupyter GitHub.

Sometimes I can't read all the lines; so I click the method then shift f12 open definition to the side. Then if I hover, I can read all the lines.

Related