Class docstring applied to fields of class (as Pycharm does)

[xxc-zsz]

Code:

@dataclass
class SessionMetadata:
    """Metadata of a Session

    Attributes:
        created_at: Date of creation, in POSIX timestamp format.
        usage_count: The number of times the session was applied to the payload.
    """

    created_at: int
    usage_count: int

Vscode:

PyCharm:

If I write the code like this in VScode, the hover document can be displayed:

@dataclass
class SessionMetadata:
    created_at: int
    """
    Date of creation, in POSIX timestamp format.
    """

    usage_count: int
    """
    The number of times the session was applied to the payload.
    """

But how to display the document in the first way of annotation?

[starball5]

Related on Stack Overflow: In VSCode, how to get on-hover documentation shown for class properties documented in the class docstring?

Also, why is this (currently) phrased as a support question if it's a feature-request?

[clouedoc]

I can confirm this issue/lack of feature. In fact, I posted the original StackOverflow question 😃
Thanks a lot for opening this issue, @xxc-zsz

[judej]

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

[prokie]

I would really like this feature to be added.

[mubarizafzal]

I would also really appreciate this feature being added!

[matsalleh92]

I would like this feature please!

[BryanFauble]

This would be very useful - as of now I have to duplicate these docstrings in both places: 1) for mkdocs, 2) for hoverdocs

[heddxh]

I would like this feature!

[robwoods-cam]

I would benefit from this feature!

[ChariseWalraven]

Same!

[JacobHast]

I would also love this!

[gomills]

I wouldn't complain as well! Looking forward for this feature. It bastly enhances performance as now I have to switch tabs constantly

[bstableynv5]

Yes, I would also like attribute documentation in the class docstring to appear when hovering over attributes. I think if, for some reason, a docstring appears on both the attribute (at creation) and the class docstring, either (1) both are concatenated somehow or (2) the attribute's docstring takes precedence.

I recently had to "downgrade" my attribute docstrings for code review because of this. Pycharm apparently does show the attribute docstrings that are defined in the class docstring when hovering over members. I don't know if it supports docstrings on the attribute as vscode does.

[rchiodo]

Our next prerelease version of Pylance should have this feature added to it.