[Numpy-discussion] umath ufunc docstrings

Pauli Virtanen pav at iki.fi
Sat May 31 15:49:37 EDT 2008


Hi,

I'd like to adjust the way numpy.core.umath ufunc docstrings are defined
to make them more easy to handle in the ongoing documentation marathon:

- Remove the signature magic in ufunc_get_doc
- Define ufunc docstrings in a separate module
  instead of in generate_umath.py, in the same format as in 
  add_newdocs.py

Suggested patch is attached; it passes numpy tests. Any thoughts on
whether it should go in?

I was also thinking about the problem with pydoc.help and ufuncs: would
making PyUFuncObject a subclass of PyFunctionObject be a reasonable fix?

	Pauli

-------------- next part --------------
A non-text attachment was scrubbed...
Name: umath-docstrings.patch
Type: text/x-patch
Size: 26303 bytes
Desc: not available
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20080531/84f723d0/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: Digitaalisesti allekirjoitettu viestin osa
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20080531/84f723d0/attachment.sig>


More information about the NumPy-Discussion mailing list