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

Documentation for built-ins on hover #12740

Closed
LordKa0S opened this issue Jul 3, 2020 · 2 comments
Closed

Documentation for built-ins on hover #12740

LordKa0S opened this issue Jul 3, 2020 · 2 comments
Labels
feature-request Request for new features or functionality

Comments

@LordKa0S
Copy link

LordKa0S commented Jul 3, 2020

I am using the extension with Python 3.8.3. On hover for any built-in, the tooltip shows only the type information (of parameters, return value etc.).
image
image

However, I'd prefer it showing the documentation of the function (wherever available) as well, so that it is clear what the function is being used for. This can be seen demonstrated in the Pylance announcement blog post for the pandas library. I expect similar functionality to be available for built-ins, given that documentation for them is already accessible via help() or __doc__. In above images for str.strip(), the tooltips should display:

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

@LordKa0S LordKa0S added triage-needed Needs assignment to the proper sub-team feature-request Request for new features or functionality labels Jul 3, 2020
@LordKa0S
Copy link
Author

LordKa0S commented Jul 3, 2020

This only happens with pylance installed

@LordKa0S
Copy link
Author

LordKa0S commented Jul 3, 2020

Cloned in the pylance repo #49

@LordKa0S LordKa0S closed this as completed Jul 3, 2020
@ghost ghost removed the triage-needed Needs assignment to the proper sub-team label Jul 3, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

1 participant