Python Twisted Documentation
In the Twisted documentation, when I open any Twisted code, I notice things like
@see: L{IReactorCore<twisted.internet.interfaces.IReactorCore>}
@ivar called: A flag which is C{False} until either C{callback} or
C{errback} is called and afterwards always C{True}.
@type called: C{bool}
Compute the allowed methods on a C{Resource} based on defined render_FOO
methods. Used when raising C{UnsupportedMethod} but C{Resource} does
not define C{allowedMethods} attribute.
Can anyone tell me what the letters C, L like C {bool}, L {IReactorCore} mean and what does @see, @ivar, @type mean?
source to share
His Epydoc markup :
C{...}
: Python source or ID.
The inline markup construct is
L{text<object>}
used to create links to documentation for other Python objects.text
is the text to be displayed for the link, andobject
is the name of the Python object to bind to. If you want to use the name of the Python object as the link text, you can simply writeL{object}``
.
The fields ( @…
) used by Twisted are specified in its documentation generator , which depends on Epydoc, pydoctor:
@author @cvar @ivar @note @param (synonym: @arg) @raise (synonym: @raises) @return (synonym: @returns) @rtype (synonym: @returntype) @see (synonym: @seealso) @type @var
source to share