VSCode: Show Python docstring of functions when in Debug Console

Question

I am trying to see the docstring of functions when I am in debug console. But it turns out there is no way. Can someone suggest??

For example, if I hover the mouse over the following, nothing happens. Then if I type CTRL-K CTRL-I, nothing happens.

torch.gather

Then if I do:

help(torch.gather)

It says the evaluation is really slow and might be deadlocked.

I ended up googling for documentation, but that is very inefficient.

Have you tried using the language service provided by the extension "Pylance"? When we hover the mouse over this code, "docstring" is displayed. — Jill Cheng
– Jill Cheng, Commented Feb 26, 2021 at 5:17
Right now, when I hover the mouse over the text in the main editor, the docstring displays, But somehow when in the debug console, when the mouse is over the text, nothing happens. — Tom Bennett
– Tom Bennett, Commented Feb 26, 2021 at 5:53
At present, the display of "docstring" in VS Code is in "Editor" (The main area to edit your files.), and it does not support displaying "docstring" in "DEBUG CONSOLE", it is used to display debugging results and code interaction of. — Jill Cheng
– Jill Cheng, Commented Feb 26, 2021 at 6:02

Jill Cheng · Accepted Answer · 2021-02-26 06:22:56Z

1

At present, the "docstring" in VS Code is displayed in "Editor" (The main area to edit your files.), and it does not support displaying "docstring" in "DEBUG CONSOLE", "DEBUG CONSOLE" is used for code interaction And display the debugging results.

If you want to see the content of "docstring" in "DEBUG CONSOLE", please use the command "help(module)" as you mentioned during debugging, it will display the content of the module:

answered Feb 26, 2021 at 6:22

Jill Cheng

10.5k1 gold badge24 silver badges30 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

sunshe35 · Accepted Answer · 2022-08-25 04:45:50Z

1

If I use help(torch.gather) in the vscode debug console, the vscode will crash and I can do nothing.

The better way is that use print(torch.gather.__doc__).

I hope help(torch.gather) can do the same thing in the future.

edited Aug 25, 2022 at 4:45

answered Aug 25, 2022 at 4:44

sunshe35

112 bronze badges

Collectives™ on Stack Overflow

VSCode: Show Python docstring of functions when in Debug Console

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related