Skip to content

Convert docstrings to numpydoc #1411

@anmyachev

Description

@anmyachev

Is your feature request related to a problem? Please describe.
Since in the near future a large number of new people will begin to work on the project, it is necessary to agree on a standard for docstrings. And introduce some kind of automatic checks.

For my part, I would like to suggest nympydoc package that we can use in github actions CI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Code Quality 💯Improvements or issues to improve quality of codebaseEpicP3Very minor bugs, or features we can hopefully add some day.documentation 📜Updates and issues with the documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions