Re: [Epydoc-devel] documentation for a c extension

[Edward L. <ed...@gr...>]

Paul Pogonyshev wrote:
> Hi,
> 
> Sorry if not the right place...
> 
> I cannot find how to specify arguments a C extension function takes.
> I can describe arguments with "@oaram name: ..." but function still
> "accepts" ... in the docs.

You should write a signature as the first line of the docstring, like 
Python's own builtins do.  E.g.:

   file(name[, mode[, buffering]]) -> file object

or:

   L.append(object) -- append object to end

epydoc will automatically parse the first line, and if it appears to be 
a signature, it will extract the args from it.  epydoc understands a 
variety of notation, including [optional] parameters, etc.  The value 
after the "--" or "->" will be treated as the @returntype field.

-Edward