Dataclasses syntax

[nrbnlulu]

Describe the bug

@dataclass
class Foo:
    bar: str
    """documentation for bar"""

Here bar is recognized by mkdocstring-python as a class-variable, it should parsed like arguments

Screenshots

While this is what I would expect:

Note that when implementing this any library that uses PEP 681 should treated the same

[pawamoy]

I don't disagree 🙂 I'll have to see if there are special cases to handle though.
In the meantime you can document these dataclass attributes with a Parameters section in the class' docstring itself:

@dataclass
class Foo:
    """blabla

    Parameters:
        bar: documentation for bar
    """

    bar: str

[gilfree]

Hi, What is your opinion about supporting not just dataclasses but all the dataclass-like objects as defined in https://peps.python.org/pep-0681/ ?

That will cover at least dataclasses, attrs and pydantic objects

[pawamoy]

I'd have to read the PEP more carefully, but once we get inheritance working it should be possible yes.

[pawamoy]

You might be interested in this Griffe extension: https://github.com/tlambert03/griffe-fieldz

[pawamoy]

Griffe recently added much better support for dataclasses, this should be fixed.