CODEWITHSUNDEEP
pythontwisted
sans0909
sans0909

Reputation: 435

Python Twisted documentation

In Twisted documentation when I open any code of Twisted 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.

Could anyone please tell me what does the letters C, L like C{bool}, L{IReactorCore} means and what does @see, @ivar, @type means?

Upvotes: 3

Views: 147

Answers (1)

Ry-
Ry-

Reputation: 224857

It’s Epydoc markup:

C{...}: Source code or a Python identifier.

The inline markup construct L{text<object>} is used to create links to the documentation for other Python objects. text is the text that should be displayed for the link, and object is the name of the Python object that should be linked to. If you wish to use the name of the Python object as the text for the link, you can simply write L{object}``.

The fields (@…) used by Twisted are listed in its documentation generator that 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

Upvotes: 4

Related Questions