Skip to content

Improve docstring structuring for code autocompletion. #3355

Open
@tomchristie

Description

@tomchristie
  • The __init__.py module should include a docstring.
  • Should class docstrings be on the class itself or on the class __init__ method (or both?).
  • Review if we've currently got a docstring on all public API, and review consistency & styling throughout.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsChanges to the documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions