Skip to content

Enforce Docstring Style Guidelines #592

Closed
@rmorshea

Description

@rmorshea

Current Situation

Right now we don't enforce any particular docstring style

Proposed Actions

Enforce Google-style docstrings with Pydocstyle.

Pydocstyle hasn't cut a release that includes support for hanging indents, but support has been merged to main. Thus we should install from this commit until a release is made:

pip install "git+https://github.com/PyCQA/pydocstyle.git@bd4993345a241bd0d5128f21de56394b1cde3714#egg=pydocstyle"

Work Items

  • enforce docstring style with pydocstyle
  • add comment explaining why we install from a specific commit on github

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority-3-lowMay be resolved one any timeline.type-docsAbout changes and updates to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions