pydoctor.epydoc2stan.FieldDesc

class documentation

class FieldDesc: (source)

Known subclasses: pydoctor.epydoc2stan.RaisesDesc, pydoctor.epydoc2stan._SignatureDesc

Constructor: FieldDesc(name, type, body)

View In Hierarchy

Combines informations from multiple Field objects into one.

Example:

   :param foo: description of parameter foo
   :type foo:  SomeClass
Method __init__ attrs generated method
Method format No summary
Instance Variable body Undocumented
Instance Variable name Field name, i.e. :param <name>:
Instance Variable type Formatted type
Constant _UNDOCUMENTED Undocumented
def __init__(self, name: str | None = None, type: Tag | None = None, body: Tag | None = None): (source)
overridden in pydoctor.epydoc2stan._SignatureDesc

attrs generated method

Parameters
name:str | NoneField name, i.e. :param <name>:
type:Tag | NoneFormatted type
body:Tag | NoneUndocumented
def format(self) -> Generator[Tag, None, None]: (source)
overridden in pydoctor.epydoc2stan.RaisesDesc
Returns
Generator[Tag, None, None]Iterator that yields one or two tags.td.
body: Tag | None = (source)

Undocumented

name: str | None = (source)

Field name, i.e. :param <name>:

type: Tag | None = (source)

Formatted type

_UNDOCUMENTED: ClassVar[Tag] = (source)

Undocumented

Value
tags.span(class_='undocumented')('Undocumented')