[Twisted-Python] epydoc and Deferreds documentation standard

Kevin Turner acapnotic at twistedmatrix.com
Thu Feb 6 14:14:22 EST 2003

Any thoughts on what the standard should be for documenting functions
that return Deferred?  Yes, "@returntype: Deferred" is accurate in one
sense, but it's important to know that Deferred will call back with an
Identity.  Or maybe the callback value of the Deferred is irrelevant, it
just happens to let you know the operation is finished.

Should we say "@returntype: L{Deferred} L{Foo}" and "@returntype:
L{Deferred} None"?

The moon is waxing crescent, 23.2% illuminated, 4.7 days old.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
Url : http://twistedmatrix.com/pipermail/twisted-python/attachments/20030206/0eeccb82/attachment.pgp 

More information about the Twisted-Python mailing list