[Numpy-discussion] Directives in numpy docstring convention
garcia.marc at gmail.com
Sun Dec 24 13:51:20 EST 2017
Is there a reason why the numpy docstring convention doesn't use the sphinx
directives .. deprecated::  and .. seealso:: ?
I see that the numpy convention  uses the .. note:: directive for the
deprecation notes, and for the "See also" it uses a section in this form:
I guess those directives were added to the sphinx after the numpy docstring
convention was created. And in this case, while is probably not worth to
update numpy docstrings, I think they should be used for new projects that
want to follow the numpy convention. Is that the case, or is there a reason
why new projects shouldn't use them?
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the NumPy-Discussion