[Numpy-discussion] Stricter numpydoc validation

Ralf Gommers ralf.gommers at gmail.com
Tue Jul 16 11:12:13 EDT 2019


On Tue, Jul 16, 2019 at 4:23 AM Gael Varoquaux <
gael.varoquaux at normalesup.org> wrote:

> > 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?
>
> Any reason that this is not done in sphinx, with the napoleon extension?
> https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html
>
> I would hope that this can increase the number of people likely to help
> maintaining.
>

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.

If someone wants to figure out how compatible these two implementations are
and whether they can be merged, that would be really welcome.

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20190716/8f5f826b/attachment.html>


More information about the NumPy-Discussion mailing list