Skip to content

Switch from documenting class.__init__ from the class docstring to the __init__ docstring #24

@andrrizzi

Description

@andrrizzi

Numpy-style documentation suggests to document the constructor in the class docstring. However, because of how sphinx renders the class API docs, I think it's more readable to move the description in __init__'s docstring.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions