Skip to content

Docstring format convention #1529

Open
Open
@fabianegli

Description

@fabianegli

Description of feature

I think it would be great to decide on a docstring format for this project to have a chance to use them consistently throughout the codebase for documentation and the generation of user friendly API docs.

The formats I like most are the one from Google and numpy with a slight preference for the latter.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions