Skip to content

[Task] Update docstrings for the public API #121

@Apricot-S

Description

@Apricot-S

Summary

Create a checklist of all public API elements and update their docstrings according to the style chosen in #120.

Scope

  • Choose a unified docstring style for the project -> reST
    • Candidates: Google, NumPy, reST
    • Note: some existing docstrings already use reST
  • Set [tool.ruff.lint.pydocstyle]
  • Update docstrings to follow the unified style

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions