CLN: D414: Section has no content

[simonjayhawkins]

No description provided.

[WillAyd]

cool thanks! just out of curiosity how many more checks do you plan on running?

[simonjayhawkins]

Some others that could be useful may conflict with validate_docstrings or dynamic docstring generation.

pydocstyle is a static checker whereas validate_docstrings imports the docstrings and checks.

pydocstyle can check all static docstrings. validate_docstrings only checks the public docstrings.

I think the new doc decorator could be an advantage here to allow static checking of more of the dynamically generated docstrings.

I think that the 'quick hit' checks done so far would add sufficient value if included in CI and enforced.

I see two main benefits. Long term to improve the quality of non-public docstrings to help contributers, but in the short term to support the review process by formalising some more style nits.