class documentation

class ParsedPlaintextDocstring(ParsedDocstring):

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method to​_node Translate this docstring to a docutils.nodes.document.
Method to​_stan Translate this docstring to a Stan tree.
Property has​_body Does this docstring have a non-empty body?
Instance Variable ​_text Undocumented

Inherited from ParsedDocstring:

Instance Variable fields A list of Fields, each of which encodes a single field. The field's bodies are encoded as ParsedDocstrings.
Instance Variable ​_stan Undocumented
def __init__(self, text):

Undocumented

Parameters
text:strUndocumented
def to_node(self):
Translate this docstring to a docutils.nodes.document.
Returns
nodes.documentThe docstring presented as a docutils.nodes.document.
def to_stan(self, docstring_linker):
Translate this docstring to a Stan tree.
Parameters
docstring​_linker:DocstringLinkerAn HTML translator for crossreference links into and out of the docstring.
Returns
TagThe docstring presented as a stan tree.
Note
The default implementation relies on functionalities provided by node2stan.node2stan and ParsedDocstring.to_node().
@property
has_body: bool =

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.

_text =

Undocumented