pydoctor.epydoc.markup.epytext.ParsedEpytextDocstring

class documentation

class ParsedEpytextDocstring(ParsedDocstring):

Undocumented

Method	`__init__`	Undocumented
Method	`__str__`	Undocumented
Method	`to_node`	Translate this docstring to a `docutils.nodes.document`.
Constant	`SYMBOL_TO_CODEPOINT`	Undocumented
Property	`has_body`	Does this docstring have a non-empty body?
Method	`_to_node`	Undocumented
Instance Variable	`_document`	Undocumented
Instance Variable	`_stan`	Undocumented
Instance Variable	`_tree`	Undocumented

Inherited from ParsedDocstring:

Method	`to_stan`	Translate this docstring to a Stan tree.
Instance Variable	`fields`	A list of `Field`s, each of which encodes a single field. The field's bodies are encoded as `ParsedDocstring`s.

def __init__(self, body, fields):

overrides pydoctor.epydoc.markup.ParsedDocstring.__init__

Undocumented

def __str__(self):

Undocumented

Returns
`str`	Undocumented

def to_node(self):

overrides pydoctor.epydoc.markup.ParsedDocstring.to_node

Translate this docstring to a docutils.nodes.document.

Returns
`nodes.document`	The docstring presented as a `docutils.nodes.document`.

SYMBOL_TO_CODEPOINT: dict[str, int] =

Undocumented

Value

{'<-': 8592,
 '->': 8594,
 '^': 8593,
 'v': 8595,
 'alpha': 945,
 'beta': 946,
 'gamma': 947,
...

@property
has_body: bool =

overrides pydoctor.epydoc.markup.ParsedDocstring.has_body

Does this docstring have a non-empty body?

The body is the part of the docstring that remains after the fields have been split off.

def _to_node(self, tree):

Undocumented

_document =

Undocumented

_stan: Optional[Tag] =

overrides pydoctor.epydoc.markup.ParsedDocstring._stan

Undocumented

_tree =

Undocumented