[Twisted-Python] epydoc and Deferreds documentation standard

Christopher Armstrong radix at twistedmatrix.com
Thu Feb 6 15:13:45 EST 2003

On Thu, Feb 06, 2003 at 11:14:22AM -0800, Kevin Turner wrote:
> 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"?

Yeah, that's what I've been doing (sometimes "L{Deferred} resulting in
L{Foo}"). It's good that epydoc doesn't really process the @returntype
in a special way, so you can still throw L{} in whereever you want.

 Twisted | Christopher Armstrong: International Man of Twistery
  Radix  |          Release Manager,  Twisted Project
---------+     http://twistedmatrix.com/users/radix.twistd/

More information about the Twisted-Python mailing list