class documentation

class PyDecoratorFunction(PyFunction):

View In Hierarchy

Description of a decorator.
Method handle​_signature Transform a Python signature into RST nodes.
Method needs​_arglist May return true if an empty argument list is to be generated even if the document contains none.
Method run Undocumented
Instance Variable name Undocumented

Inherited from PyFunction:

Method add​_target​_and​_index Undocumented
Method get​_index​_text Return the text for the index entry of the object.
Method get​_signature​_prefix May return a prefix to put before the object name in the signature.
Class Variable option​_spec Undocumented

Inherited from PyObject (via PyFunction):

Method after​_content Handle object de-nesting after content
Method before​_content Handle object nesting before content
Class Variable allow​_nesting Class is an object that allows for nested namespaces
Class Variable doc​_field​_types Undocumented
def handle_signature(self, sig, signode):

Transform a Python signature into RST nodes.

Return (fully qualified name of the thing, classname if any).

If inside a class, the current class name is handled intelligently: * it is stripped from the displayed name if present * it is added to the full name (return value) if not present

Parameters
sig:strUndocumented
signode:desc_signatureUndocumented
Returns
Tuple[str, str]Undocumented
def needs_arglist(self):
May return true if an empty argument list is to be generated even if the document contains none.
Returns
boolUndocumented
def run(self):

Undocumented

Returns
List[Node]Undocumented
name: str =

Undocumented