pandas 1.4.2

This decorator should be robust even if func.__doc__ is None (for example, if -OO was passed to the interpreter)

Usage: construct a docstring.Substitution with a sequence or dictionary suitable for performing substitution; then decorate a suitable function with the constructed object. e.g.

sub_author_name = Substitution(author='Jason')

@sub_author_name def some_function(x): "%(author)s wrote this function"

# note that some_function.__doc__ is now "Jason wrote this function"

One can also use positional arguments.

sub_first_last_names = Substitution('Edgar Allen', 'Poe')

@sub_first_last_names def some_function(x): "%s %s wrote the Raven"

A decorator to take a function's docstring and perform string substitution on it.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/util/_decorators.py#409
type: <class 'type'>
Commit: