Cython needs better support for API documentation

[scoder]

Currently, Python functions and methods in Cython generated C modules cannot provide their signature to interactive introspection. This is a major problem for the "help()" function in the interpreter (where function signatures look like "parse(...)"), but also to API doc generation tools like epydoc.

epydoc supports a special first line in the docstring here that mimics the look of the signature:

http://epydoc.sourceforge.net/api/epydoc.docstringparser-module.html#parse_function_signature
http://epydoc.sourceforge.net/api/epydoc.docstringparser-pysrc.html#parse_function_signature

Cython could generate such a line based on the original source signature.

[robertwb (robertwb)]

Due to a patch by Nick Alexander, special functions now inherit docstrings et. al.

[William Stein (wstein)]

YES!

On 8/20/07, robertwb <email address hidden> wrote:
> Due to a patch by Nick Alexander, special functions now inherit
> docstrings et. al.
>
> --
> Cython needs better support for API documentation
> https://bugs.launchpad.net/bugs/129236
> You received this bug notification because you are a member of Cython-
> dev, which is the bug contact for Cython.
>

--
William Stein
Associate Professor of Mathematics
University of Washington
http://www.williamstein.org