[Numpy-discussion] Stricter numpydoc validation

2019-07-16 Thread Marc Garcia
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

[Numpy-discussion] Directives in numpy docstring convention

2017-12-24 Thread Marc Garcia
Hi there, Is there a reason why the numpy docstring convention doesn't use the sphinx directives .. deprecated:: [1] and .. seealso:: [2]? I see that the numpy convention [3] uses the .. note:: directive for the deprecation notes, and for the "See also" it uses a section in this form: See also