Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Separate window for Python docstrings

See original GitHub issue

The Intellisense window is too small for some Python docstrings. Here is an example from Plotly:

The window crushes everything together, is too small to read long texts, and disappears too easily on mouse movement. It also suppresses some text at the beginning, which should read Signature: fe.add_scatter(.

I propose to have an option to “dock” the popup Intellisense window into the VS Code UI, so that the result is similar to JupyterLab’s “Contextual Help” tab:

It would also be good to have a dedicated shortcut, e.g. Ctrl-I, which directly shows the documentation in that docked window (again, JupyterLab style).

Issue Analytics

State:
Created 3 years ago
Reactions:3
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

karthiknadigcommented, May 7, 2020

Thank you for the suggestion! We have marked this issue as “needs decision” to make sure we have a conversation about your idea. We plan to leave this feature request open for at least a month to see how many 👍 votes the opening comment gets to help us make our decision.

0reactions

allefeldcommented, Jun 15, 2020

@luabud, yes exactly! I had searched issues, but not found that one. I wouldn’t necessarily call it a “data science feature” since it is useful for any kind of programming.

Top Results From Across the Web

python - How to access a docstring from a separate script?

Let's the docstring you want to access belongs to the file, file.py . You can get the docstring by doing the following:

Python Docstrings Tutorial : Examples & Format for Pydoc ...

See Python Docstrings. Learn about the different types of docstrings & various docstring formats like Sphinx, Numpy, and Pydoc with examples now.

PEP 8 – Style Guide for Python Code

Imports should usually be on separate lines: · Imports are always put at the top of the file, just after any module comments...

Specify types with docstrings | PyCharm Documentation

PyCharm provides an intention action that makes it possible to collect type information at runtime, and define type specifications.

VS Code Python Tool Does Multiple Interactive Windows

Just open the settings page (File > Preferences > Settings), search for 'interactive window mode' and change the setting value to 'perFile.' Now ......