Validation is not strict enough #213
Description
The docs suggest that python -m numpydoc can be used to validate docstrings. However, numpydoc reports only the most egregious breakages of the standard.
If we want to help users write high quality docstrings, we should provide a stronger checker.
In the following example, only the incorrect header gets caught:
def foo(x):
"""The first line should be a one line description, not a multiple
paragraph sentence.
References
----------
These are out of place and incorrectly formatted.
Some Heading
------------
Unknown heading
Parameters
----------
x :
I should specify a type for this parameter
"""
return x