Skip to content

Add docstring style enforcement #11

Open
@ginic

Description

@ginic

Docstrings: While the project uses Sphinx for documentation, it could be beneficial to enforce a consistent docstring style (like Google or NumPy) using a tool like pydocstyle.

Definition of done:

  • Add docstring style enforcement to developer dependencies
  • Update documentation section of README to describe what docstring style enforcement is and how to run it

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions