class documentation

class desc_signature(_desc_classes_injector, nodes.Part, nodes.Inline, nodes.TextElement):

View In Hierarchy

Node for a single object signature.

As default the signature is a single-line signature. Set is_multiline = True to describe a multi-line signature. In that case all child nodes must be desc_signature_line nodes.

This node always has the classes sig, sig-object, and the domain it belongs to.

Class Variable classes Undocumented
Property child​_text​_separator Undocumented

Inherited from _desc_classes_injector:

Method __init__ Undocumented

Inherited from not_smartquotable (via _desc_classes_injector):

Class Variable support​_smartquotes Undocumented
classes: list[str] =
@property
child_text_separator =

Undocumented