[wingide-users] epydoc!

Jason L Connor jconnor at redhat.com
Tue Oct 4 10:53:51 MDT 2011


On Tue, 2011-10-04 at 17:32 +0100, Michael Foord wrote:
> Although epydoc itself is dead, right? (No longer maintained and
> pretty serious bugs in the output from the last released version.)

I don't really think there are serious bugs in it. I'm not sure if it's
still maintained or not. Personally I use it all the time.

> Does sphinx, along with its autodoc extensions, have any convention
> around parameter types and return values? 

It does. In it's python domain it also uses the type and rtype
documentation. For example:

def my_func(arg1, arg2):
    """
    :param arg1: first argument
    :type arg1: int
    :rtype: str
    """
-- 
Jason L Connor
linear on freenode #pulp
http://pulpproject.org/
RHCE: 805010912355231
GPG Fingerprint: 2048R/CC4ED7C1
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: This is a digitally signed message part
Url : /pipermail/wingide-users/attachments/20111004/de49d0ff/attachment.bin


More information about the wingide-users mailing list