Address failing numpydoc tests #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

ukmo-ccbunney opened this issue Nov 14, 2024 · 0 comments

Labels

Contributor

ukmo-ccbunney commented Nov 14, 2024 •

edited

Loading

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

The text was updated successfully, but these errors were encountered:

ukmo-ccbunney added the repo-checking label

ukmo-ccbunney mentioned this issue

Initial setup of QA pre-commit tools [cf-units] #522

Merged

trexfeathers added this to 🚴 Peloton

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment