Feature Request: View docstrings inside of import paths.

[hacker-DOM]

Hi there!

When I have a module (file) f.py with

__doc__ = "xyz"

And in a different file

import my_package.f

i would expect that triggering editor.action.showDefinitionPreviewHover on f would show a hover with contents "xyz".

However, it only shows (module) f.

Thank you for considering my issue!

[erictraut]

Module-level docstrings are supported if you have a docstring at the top of the module. They are not supported if you dynamically assign a value to the __doc__ variable. Keep in mind that a static type analyzer doesn't actually run the code.

[hacker-DOM]

Thank you for your answer, however, I am still getting unexpected behavior. I have tried to document this.

tldr: it only works for relative imports, not for absolute imports

Thanks 🙏

[erictraut]

Docstrings are displayed for symbols, not for import paths. In the expression from a.b.c import d, a.b.c is an import path (as is a and a.b); d is the imported symbol. That explains the difference you're seeing.

It sounds like you are interested in seeing module docstrings for module paths when they refer to a module. That's a reasonable enhancement request.

[judej]

Moving this issue to discussion as an enhancement request for comments and upvotes.