[SciPy-Dev] Clarification: is the Extended Summary section optional?

Stéfan van der Walt stefan@sun.ac...
Wed Jun 2 13:23:55 CDT 2010


On 2 June 2010 04:22, Ralf Gommers <ralf.gommers@googlemail.com> wrote:
>>> >> Typically, there is no reason not to have an extended section.  Can
>>> >> you give an example where it would seem unnecessary?
>
> I think we shouldn't go overboard here. In the great majority of cases it's
> needed but sometimes there's just not much info to add besides what's in the
> summary and parameter description. Examples:
> http://docs.scipy.org/numpy/docs/numpy.core.umath.add/
> http://docs.scipy.org/numpy/docs/numpy.lib.ufunclike.isneginf/
> http://docs.scipy.org/numpy/docs/numpy.core.umath.logical_or/

Thanks, Ralf.  Those are the examples I was looking for, and I agree.

Regards
Stéfan


More information about the SciPy-Dev mailing list