Somehow I didn’t realize numpydoc has a docstring linter! https://numpydoc.readthedocs.io/en/stable/validation.html
A quick test of it on the codebase here shows lots of violations. Some are probably not a big deal (e.g. web_monitoring_diff/content_type.py:55: SA01 See Also section not found), but I’m sure others are definitely stuff we should clean up (e.g. web_monitoring_diff/content_type.py:89: PR06 Parameter "a_text" type should use "str" instead of "string"). We probably need some considered configuration.
This probably pairs well with a switch to pyproject.toml. 🙂
Somehow I didn’t realize numpydoc has a docstring linter! https://numpydoc.readthedocs.io/en/stable/validation.html
A quick test of it on the codebase here shows lots of violations. Some are probably not a big deal (e.g.
web_monitoring_diff/content_type.py:55: SA01 See Also section not found), but I’m sure others are definitely stuff we should clean up (e.g.web_monitoring_diff/content_type.py:89: PR06 Parameter "a_text" type should use "str" instead of "string"). We probably need some considered configuration.This probably pairs well with a switch to
pyproject.toml. 🙂