pydoctor.epydoc.markup.Field

class documentation

class Field: (source)

View In Hierarchy

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.

Method __init__ Undocumented
Method __repr__ Undocumented
Method arg No summary
Method body No summary
Method tag No summary
Instance Variable lineno Undocumented
Instance Variable _arg Undocumented
Instance Variable _body Undocumented
Instance Variable _tag Undocumented
def __init__(self, tag, arg, body, lineno): (source)

Undocumented

Parameters
tag:strUndocumented
arg:Optional[str]Undocumented
body:ParsedDocstringUndocumented
lineno:intUndocumented
def __repr__(self): (source)

Undocumented

Returns
strUndocumented
def arg(self): (source)
Returns
Optional[str]This field's argument, or None if this field has no argument.
def body(self): (source)
Returns
ParsedDocstringThis field's body.
def tag(self): (source)
Returns
strThis field's tag.
lineno = (source)

Undocumented

_arg = (source)

Undocumented

_body = (source)

Undocumented

_tag = (source)

Undocumented