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).
A stand alone tool would be fine, a flake8 plug-in perhaps even better -
see al
On Tue, Jul 16, 2019 at 4:23 AM Gael Varoquaux <
gael.varoqu...@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
> 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/extension
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.
The one thing I worry about is maintenance burden, where numpydoc is
alr
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 desc
