Skip to content

Feature request: Add support for dataclasses #604

@Dementiy

Description

@Dementiy

At the moment numpydoc will ignore "Attributes" section for dataclasses (or maybe I don't quite understand how to document dataclasses properly):

@dataclass
class Klass:
    """
    Klass description.

    Attributes
    ----------
    attr: int
        Some attribute description.
    """

    attr: int

It would be great to have such a feature.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions