pydoctor.epydoc.markup._pyval_repr.ColorizedPyvalRepr

class documentation

class ColorizedPyvalRepr(ParsedRstDocstring):

View In Hierarchy

Method __init__ Undocumented
Method to​_stan Translate this docstring to a Stan tree.
Instance Variable is​_complete True if this colorized repr completely describes the object.
Instance Variable warnings List of warnings

Inherited from ParsedRstDocstring:

Method __repr__ Undocumented
Method to​_node Translate this docstring to a docutils.nodes.document.
Property has​_body Does this docstring have a non-empty body?
Instance Variable ​_document A ReStructuredText document, encoding the docstring.

Inherited from ParsedDocstring (via ParsedRstDocstring):

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, document, is_complete, warnings):
overrides pydoctor.epydoc.markup.restructuredtext.ParsedRstDocstring.__init__

Undocumented

Parameters
document:nodes.documentUndocumented
is​_complete:boolUndocumented
warnings:List[str]Undocumented
def to_stan(self, docstring_linker):
overrides pydoctor.epydoc.markup.ParsedDocstring.to_stan
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().
is_complete =
True if this colorized repr completely describes the object.
warnings =
List of warnings