[Numpy-discussion] Extending documentation to c code

Charles R Harris charlesr.harris at gmail.com
Mon May 24 14:01:45 EDT 2010


Hi All,

I'm wondering if we could extend the current documentation format to the c
source code. The string blocks would be implemented something like

/**NpyDoc
"""The Answer.

Answer the Ultimate Question of Life, the Universe, and Everything.

Parameters
----------
We don't need no stinkin' parameters.

Notes
-----
The run time of this routine may be excessive.

"""
*/
int
answer_ultimate_question(void)
{
    return 42;
}

and the source scanned to generate the usual documentation. Thoughts?

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


More information about the NumPy-Discussion mailing list