Skip to content

Add examples to docstrings in classes and functions #392

@RaczeQ

Description

@RaczeQ

Currently, the code usage isn't clear for new users. We should write examples in the docstring where needed just like pandas or scikit.

https://gist.github.com/redlotus/3bc387c2591e3e908c9b63b97b11d24e#file-docstrings-py-L142

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions