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]

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