pandas 1.4.2

Parameters
doc(*docstrings: 'str | Callable', **params) -> 'Callable[[F], F]'

This decorator will add a variable "_docstring_components" to the wrapped callable to keep track the original docstring template for potential usage. If it should be consider as a template, it will be saved as a string. Otherwise, it will be saved as callable, and later user __doc__ and dedent to get docstring.

Parameters

*docstrings : str or callable

The string / docstring / docstring template to be appended in order after default docstring under callable.

**params :

The string which would be used to format docstring template.

A decorator take docstring templates, concatenate them 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#348
type: <class 'function'>
Commit: