<div><div dir="auto">I’d find this sort of (stricter) numpydoc validation tool very useful, especially if the different codes can be selectively enforced while bringing a large code base into compliance (as pandas seems to have used this).</div></div><div dir="auto"><br></div><div dir="auto">A stand alone tool would be fine, a flake8 plug-in perhaps even better - see also my <div><a href="https://github.com/peterjc/flake8-rst-docstrings">https://github.com/peterjc/flake8-rst-docstrings</a> for doing basic RST validation of docstrings (but not their contents as we are discussing here). The nice thing with writing a flake8 plugin is that handles include/excluding of codes and file names for you.</div><div dir="auto"><br></div><div dir="auto">Regards,</div></div><div dir="auto"><br></div><div dir="auto">Peter</div><div dir="auto"><br></div><div><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, 16 Jul 2019 at 16:13, Ralf Gommers <<a href="mailto:ralf.gommers@gmail.com">ralf.gommers@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jul 16, 2019 at 4:23 AM Gael Varoquaux <<a href="mailto:gael.varoquaux@normalesup.org" target="_blank">gael.varoquaux@normalesup.org</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">> The one thing I worry about is maintenance burden, where numpydoc is already<br>
> spread a little bit thin -- would any of the Pandas developers be willing to<br>
> maintain it?<br>
<br>
Any reason that this is not done in sphinx, with the napoleon extension?<br>
<a href="https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html" rel="noreferrer" target="_blank">https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html</a><br>
<br>
I would hope that this can increase the number of people likely to help<br>
maintaining.<br></blockquote><div><br></div><div>Just history. Numpydoc came first, most projects rely on it. Napoleon came way later and then did its own numpy docstring support rather than contribute to numpydoc or propose a merge. <br></div><div><br></div><div>If someone wants to figure out how compatible these two implementations are and whether they can be merged, that would be really welcome.</div><div><br></div><div>Cheers,<br></div><div>Ralf</div><div><br></div></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></div>