Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstring tooltips over parameters not displaying for packages which use Python stubs #6777

Open
pfbuxton opened this issue Dec 16, 2024 · 1 comment
Assignees
Labels
needs repro Issue has not been reproduced yet

Comments

@pfbuxton
Copy link

Adding "python.analysis.supportRestructuredText": true partially fixes the docstrings (as described in #2251)

For local packages, tooltips over parameters are working for Sphinx formatting style:

and for NumPy/SciPy formatting style:

However, with compiled code, which use *.pyi files for the docstrings the hover does not work, here is an example:

Hovering over linspace we see that the "Parameters" have been correctly formatted:
Image

I find these type of features particularly useful. As there is a lot of important information, even in a simple package like np.linspace, or knowing that height should be in centimetre as in my example.

@github-actions github-actions bot added the needs repro Issue has not been reproduced yet label Dec 16, 2024
@rchiodo
Copy link
Contributor

rchiodo commented Dec 16, 2024

Trigger Parameter Hints will show them. Hover tips just haven't been implemented yet for parameters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs repro Issue has not been reproduced yet
Projects
None yet
Development

No branches or pull requests

3 participants