Skip to content

Add support for class attribute list auto-generation #139

Open
@zoj613

Description

@zoj613

Is it possible to add support for auto-generating class attributes? According the numpydocs convention, class attributes are encouraged to be included when adding docstring for a class. Something like:

class Test:
   """Test.
    
    Attributes
    ----------
    name : str
    another : float
   """
   name: str
   another: float

Currently, the behaviour when using the numpy style is:

class Test:
   """Test.
   """
   name: str
   another: float

If this is already supported via a particular setting please feel free to direct me to the relevant documentation.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions