<div dir="ltr">I have written and/or used something like this (though not nearly as complete!) in several other projects. It would be great to have one maintained source for such a checker, and numpydoc seems like a reasonable place for it.<div><br></div><div>The one thing I worry about is maintenance burden, where numpydoc is already spread a little bit thin -- would any of the Pandas developers be willing to maintain it?<div><br></div><div>Eric</div><div><br></div></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jul 16, 2019 at 6:56 AM Marc Garcia <<a href="mailto:garcia.marc@gmail.com">garcia.marc@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div class="gmail_default" style="font-size:small">In pandas we've been, for more than a year now, enforcing a stricter numpydoc standard. And we've got a script to help with it, which validates things like capitalization and punctuation of paragraphs, the documented parameters (they must match the ones in the signature, have both a type and a description...), PEP-8 of the standards, and many more things, so all our docstrings are consistent.</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">I saw that there is an issue with a discussion on having a more strict standard for numpydoc, I added a comment there on whether would make sense to move the pandas standard and validation code to numpydoc: <a href="https://github.com/numpy/numpydoc/issues/213#issuecomment-511760580" target="_blank">https://github.com/numpy/numpydoc/issues/213#issuecomment-511760580</a></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">I think it's worth opening the discussion here too. Is there interest in the rest of the community on having a stricter standard, and move the pandas validation (with the required updates) to numpydoc? Of course we can discuss also the exact standard, but probably worth finding out first if a stricter numpydoc standard would make sense for everyone.</div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">You can find the documentation of our standard at: <a href="https://dev.pandas.io/development/contributing_docstring.html" target="_blank">https://dev.pandas.io/development/contributing_docstring.html</a></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">And the script that we use to validate, as well as the exact list of errors we detect in: <a href="https://github.com/pandas-dev/pandas/blob/master/scripts/validate_docstrings.py#L76" target="_blank">https://github.com/pandas-dev/pandas/blob/master/scripts/validate_docstrings.py#L76</a></div><div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Cheers!</div></div>
_______________________________________________<br>
NumPy-Discussion mailing list<br>
<a href="mailto:NumPy-Discussion@python.org" target="_blank">NumPy-Discussion@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/numpy-discussion" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/numpy-discussion</a><br>
</blockquote></div>