Skip to content

Address failing numpydoc tests #298

Open
@ukmo-ccbunney

Description

@ukmo-ccbunney

📰 Custom Issue

numpydoc pre-commit hook is failing the following checks that need to addressed (currently they are added to an ignore list):

### Tasks
- [ ] `GL08`  No docstring
- [ ] `SS05` Summary must start with infinitive verb
- [ ] `SS06`  Summary should fit on one line
- [ ] `PR01`  Parameters not documented
- [ ] `PR06`  Wrong type used
- [ ] `PR08`  Description should start with capitol letter
- [ ] `RT01`  No Returns section found

Metadata

Metadata

Assignees

No one assigned

    Labels

    New: IssueHighlight a new community raised "generic" issue

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions