Skip to content

Clean all type hints/docstrings #33

@jared321

Description

@jared321

PR #19 is large. To ensure a good review of that and in light of the fact that we have not yet converged on rules for type hinting and Sphinx docstring formatting, reviewing type hints and docstrings in that PR are taking a back seat. Specifically, we will allow incorrect type hints and docstrings to make it into main.

After finishing the design work mentioned in Issue #29, we will need a campaign to update the type hints and docstrings to be correct and adhere to design goals. This should also include ensuring that all docs are using the appropriate Sphinx-based macros.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions