epydoc.markup.Field

Package epydoc :: Package markup :: Class Field

Class Field
source code

The contents of a docstring's field. Docstring fields are used to describe specific aspects of an object, such as a parameter of a function or the author of a module. Each field consists of a tag, an optional argument, and a body:

The tag specifies the type of information that the field encodes.
The argument specifies the object that the field describes. The argument may be None or a string.
The body contains the field's information.

Tags are automatically downcased and stripped; and arguments are automatically stripped.