Skip to content

enable docstring checks #174

Description

@nhsavage

At the moment key docstring checks are ignored. Do this on it's own ticket to avoid complicating other changes, as there are a lot of fixes that will be needed.

Start by removing PR01, PR02, PR04, PR07, RT01, and RT03 from the ignored list in pyproject.toml re-run pre-commit and fix errors

    "GL08",  # The object does not have a docstrings not have a docstring
    "PR01",  # Parameters ... not documented
    "PR02",  # Unknown parameters {....}
    "PR04",  # Parameter "...." has no type
    "PR07",  # Parameter "...." has no description
    "RT01",  # No Returns section found
    "RT03",  # Return value has no description

Metadata

Metadata

Assignees

No one assigned

    Labels

    quality-assuranceCode quality and consistency issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions