[Cython] autodoc function/method signatures

[Stefan Behnel]

Hi,

Lisandro Dalcin wrote:
> On Mon, Sep 8, 2008 at 1:18 PM, Robert Bradshaw
>> I'd render them the natural way, e.g. [return-type] name([type] arg,
>> [type] arg, ...)
> 
> That's the natural way from a C function. Docstrings do not apply for
> 'cdef' functions, but for 'cdef' of 'cpdef'.
> 
> Additionally, for 'def' functions, I have no idea how to provide a
> good 'return-type'.

Also note that e.g. epydoc is not particularly smart about what it understands
as a signature. One might consider that a bug in epydoc, but as long as we can
generate a simple-enough signature that it can parse and that users can read,
I don't think there's much gained by additionally providing type information,
for example.


> Other stuff I'm not sure how to render is __get__/__set__/__del__ on
> properties. Should I generate docstrings for them?

There's only one visible docstring for them, which is the docstring of the
property itself (i.e. of the descriptor). So augmenting the docstring doesn't
make much sense.

Stefan