matplotlib.docstring

classmatplotlib._docstring.Substitution(*args, **kwargs)[source]

Bases: object

Декоратор, выполняющий %-подстановку в строке документации объекта.

Этот декоратор должен быть устойчивым даже если obj.__doc__ равно None (например, если -OO был передан в интерпретатор).

Использование: создать docstring.Substitution с последовательностью или словарем, подходящим для выполнения подстановки; затем украсить подходящую функцию созданным объектом, например:

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"

Также можно использовать позиционные аргументы:

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

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

update(*args, **kwargs)[source]

Обновить self.params (который должен быть словарем) с предоставленными аргументами.

matplotlib._docstring.copy(source)[source]

Копировать строку документации из другой исходной функции (если она присутствует).