pydoctor.epydoc.markup.Field

class documentation

class Field: (source)

Constructor: Field(tag, arg, body, lineno)

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 replace_body Undocumented
Method tag No summary
Instance Variable lineno Undocumented
Instance Variable _arg Undocumented
Instance Variable _body Undocumented
Instance Variable _tag Undocumented
def __init__(self, tag: str, arg: str | None, body: ParsedDocstring, lineno: int): (source)

Undocumented

def __repr__(self) -> str: (source)

Undocumented

def arg(self) -> str | None: (source)
Returns
str | NoneThis field's argument, or None if this field has no argument.
def body(self) -> ParsedDocstring: (source)
Returns
ParsedDocstringThis field's body.
def replace_body(self, newbody: ParsedDocstring): (source)

Undocumented

def tag(self) -> str: (source)
Returns
strThis field's tag.
lineno = (source)

Undocumented

_arg = (source)

Undocumented

_body = (source)

Undocumented

_tag = (source)

Undocumented