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

Module Header Information (e.g., docstrings) should be displayed in the tool tip for files in the vscode explorer view. #210427

Open
hucker opened this issue Apr 15, 2024 · 1 comment
Assignees
Labels
feature-request Request for new features or functionality file-explorer Explorer widget issues

Comments

@hucker
Copy link

hucker commented Apr 15, 2024

I don't know if this should be Python-specific or VSCode-specific, but the feature applies to any language that supports docstring-like attributes. Rust has ///, and Java has /** that would be similar to Python's module docstrings.

In Python, the function's docstring is displayed when you hover over a function name in an editor window. When you hover over a Python module (for example, something.py) in the Explorer view, you get the full path and a count of the file's issues and git info. Why don't we get the module docstring here as well? While the git and error info are essential, the docstrings could be the most valuable, especially when looking at a library code in a new codebase. File date/time info would be helpful.

@joyceerhl joyceerhl assigned mjbvz and unassigned joyceerhl Apr 16, 2024
@mjbvz mjbvz assigned lramos15 and unassigned mjbvz Apr 16, 2024
@lramos15 lramos15 added feature-request Request for new features or functionality file-explorer Explorer widget issues labels Apr 17, 2024
@VSCodeTriageBot VSCodeTriageBot added this to the Backlog Candidates milestone Apr 17, 2024
@VSCodeTriageBot
Copy link
Collaborator

This feature request is now a candidate for our backlog. The community has 60 days to upvote the issue. If it receives 20 upvotes we will move it to our backlog. If not, we will close it. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality file-explorer Explorer widget issues
Projects
None yet
Development

No branches or pull requests

5 participants