Skip to content

Address failing numpydoc tests #521

@ukmo-ccbunney

Description

@ukmo-ccbunney

The following numpydoc errors are being generated and need addressing:

### Numpydoc error codes
- [ ] `GL08`  The object does not have a docstring
- [ ] `PR01` Parameters {xxxx} not documented
- [ ] `RT01` No Returns section found
- [ ] `SS03` Summary does not end with a period
- [ ] `SS06` Summary should fit in a single line
- [ ] `SS05` Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")

These are currently being set to be ignored in the pyproject.toml

Metadata

Metadata

Assignees

No one assigned

    Projects

    Status

    No status

    Status

    TBC

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions