ISISNeutronMuon / ISISNeutronMuon/MDMC
Numpy docstrings validation
- Dominant language
- Python
- Stars
- 4
- Forks
- 0
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 5
Description
**Is your feature request related to a problem? Please describe.**
Docstring documentation do not necessarily conform to numpy doc standards, e.g. some variable types are separated by `variable: type`, rather than `variable : type`.
**Describe the solution you'd like**
Numpydoc provides mechanisms for validating that docstrings conform to standards, some listed here:
https://numpydoc.readthedocs.io/en/latest/validation.html
A rewrite of some of the docs to correct certain issues highlighted by these tools could improve documentation along with eventual integration into the CI.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.