DOCS: Adopt the numpydoc validation rules
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the [tool.numpydoc_validation] section in pyproject.toml and review the listed GL08, PR01, PR02, PR04, PR07, RT01, and RT03 rules. Uncomment each rule in turn and run pre-commit run --all-files to inspect the reported errors. Done means the outstanding rules have been reviewed and adopted where possible, with only necessary exceptions remaining.
Written by the indexing model from the issue text.
Description
📚 Documentation
The pre-commit hook to check these rules was added in https://github.com/SciTools/iris/pull/5762.
The outstanding rules review and ideally adoption are below as defined in pyproject.toml (section [tool.numpydoc_validation]). There is an option to keep them ignored only it absolutely needed.
-
GL08The object does not have a docstring :1320 errors -
PR01Parameters ... not documented :951 errors -
PR02Unknown parameters {....} -74 errors -
PR04Parameter "...." has no type :407 errors -
PR07Parameter "...." has no description :47 errors -
RT01No Returns section found :609 errors -
RT03Return value has no description :219 errors
To test these rules just comment out one at a time and then run the pre-commit locally via pre-commit run --all-files.
For more information see https://numpydoc.readthedocs.io/en/latest/validation.html.
See also #5625 ruff: incremental adoption.
- Dominant language
- Python
- Stars
- 724
- Forks
- 317
- Avg merge
- 3d 20h
- Merged PRs (30d)
- 9
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SciTools/iris
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100