[Numpy-discussion] Documentation errors

Charles R Harris charlesr.harris at gmail.com
Sat May 14 11:45:12 EDT 2011


A number of the ufuncs in the reference doc are missing arguments, for
example

remainder(x1) Return element-wise remainder of division.
mod(x1) Return element-wise remainder of division.
fmod(x1) Return the element-wise remainder of division.
absolute() Calculate the absolute value element-wise.
rint() Round elements of the array to the nearest integer.
sign() Returns an element-wise indication of the sign of a number.
conj() Return the

And this is true of binary ufuncs as well

greater(x1) Return the truth value of (x1 > x2) element-wise.
greater_equal(x1) Return the truth value of (x1 >= x2) element-wise.
less(x1) Return the truth value of (x1 < x2) element-wise.
less_equal(x1) Return the truth value of (x1 =< x2) element-wise.
not_equal(x1) Return (x1 != x2) element-wise.
equal(x1) Return (x1 == x2) element-wise.

These are generated by the .. autosummary:: command, so the error probably
lies there.

Also, what is the easiest way to generate the reference guide for testing
purposes? Can the autosummary command deal with classes that are only
generated when modules are imported? I want to document the new polynomial
classes but they are generated on the fly from templates.

Chuck
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20110514/98dca380/attachment.html>


More information about the NumPy-Discussion mailing list