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

Provide more detailed document by pydoc #5437

Closed
Freed-Wu opened this issue Jul 6, 2023 · 2 comments
Closed

Provide more detailed document by pydoc #5437

Freed-Wu opened this issue Jul 6, 2023 · 2 comments
Labels
enhancement request New feature or request

Comments

@Freed-Wu
Copy link

Freed-Wu commented Jul 6, 2023

This is documents provided by pyright:

Screenshot from 2023-07-06 23-53-25
Screenshot from 2023-07-06 23-53-02
Screenshot from 2023-07-06 23-52-44

This is documents provided by jedi:

Screenshot from 2023-07-06 23-52-12
Screenshot from 2023-07-06 23-52-03
Screenshot from 2023-07-06 23-51-30

These details provided by jedi comes from pydoc. Can pyright provide more detailed document?

@Freed-Wu Freed-Wu added the enhancement request New feature or request label Jul 6, 2023
@Freed-Wu Freed-Wu changed the title More detailed document hover Provide more detailed document by pydoc Jul 6, 2023
@erictraut
Copy link
Collaborator

Pyright is a static analyzer. Unlike jedi, it doesn't run the code it analyzes or perform any runtime introspection. This is by design.

Pylance, which is the VS Code language server that builds upon pyright, bundles doc strings for stdlib modules. So if you want this functionality, you can switch to Pylance. We have no plans to include this functionality in pyright, which is focused on type checking. Pyright does include some basic language server features, but it's really focused on type checking.

@Freed-Wu
Copy link
Author

Freed-Wu commented Jul 7, 2023

Oh, I use coc.nvim which only have extension for pyright but doesn't have any extension for pylance. 😢

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement request New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants