class ParsedPlaintextDocstring(ParsedDocstring):
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 Field s, each of which encodes a single field. The field's bodies are encoded as ParsedDocstrings. |
Instance Variable | _stan |
Undocumented |
docutils.nodes.document
.Returns | |
nodes.document | The docstring presented as a docutils.nodes.document . |
Parameters | |
docstring_linker:DocstringLinker | An HTML translator for crossreference links into and out of the docstring. |
Returns | |
Tag | The docstring presented as a stan tree. |
Note | |
The default implementation relies on functionalities provided by node2stan.node2stan and ParsedDocstring.to_node() . |