class documentation
class ParsedStanOnly(ParsedDocstring): (source)
A ParsedDocstring
directly constructed from stan, for caching purposes.
to_stan
method simply returns back what's given to ParsedStanOnly.__init__
.
Method | __init__ |
Undocumented |
Method | has |
Does this docstring have a non-empty body? |
Method | to |
Translate this docstring to a nodes.document . |
Method | to |
Translate this docstring to a Stan tree. |
Instance Variable | _fromstan |
Undocumented |
Inherited from ParsedDocstring
:
Method | get |
Returns the summary of this docstring. |
Method | get |
The table of contents of the docstring if titles are defined or None. |
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 | _compact |
Undocumented |
Instance Variable | _stan |
Undocumented |
Instance Variable | _summary |
Undocumented |
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.
Returns | |
bool | Undocumented |
Translate this docstring to a nodes.document
.
Returns | |
Any | The docstring presented as a nodes.document . |
Note | |
Some ParsedDocstring subclasses do not support docutils nodes. This method might raise NotImplementedError in such cases. (i.e. pydoctor.epydoc.markup._types.ParsedTypeDocstring ) |
Translate this docstring to a Stan tree.
Parameters | |
docstringAny | An HTML translator for crossreference links into and out of the docstring. |
compact:bool | Undocumented |
Returns | |
Tag | The docstring presented as a stan tree. |
Raises | |
Exception | If something went wrong. Callers should generally catch Exception when calling to_stan() . |
Note | |
The default implementation relies on functionalities provided by node2stan.node2stan and ParsedDocstring.to_node() . |