[Numpy-discussion] documenting optional out parameter

Brent Pedersen bpederse@gmail....
Sun Oct 25 21:16:06 CDT 2009


hi, i've seen this section:
http://docs.scipy.org/numpy/Questions+Answers/#the-out-argument

should _all_ functions with an optional out parameter have exactly that text?
so if i find a docstring with reasonable, but different doc for out,
should it be changed
to that?

and if a docstring of a function with an optional out that needs
review does not have
the out parameter documented should it be marked as 'Needs Work'?

thanks,
-brentp


More information about the NumPy-Discussion mailing list