matplotlib.docstring

классmatplotlib._docstring.Substitution(*args, **kwargs)[source]

Базы: 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]

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

matplotlib._docstring.kwarg_doc(text)[source]

Декоратор для определения документации kwdoc свойств художника.

Этот декоратор может быть применён к методам-сеттерам свойств художника. Переданный текст хранится в закрытом атрибуте _kwarg_doc метода. Он используется для переопределения автоматически сгенерированной документации в списке kwdoc для художников. Список kwdoc используется для документирования **kwargs когда они являются свойствами художника. См., например, раздел **kwargs в Axes.text.

Текст должен содержать поддерживаемые типы, а также значение по умолчанию, если применимо, например:

@_docstring.kwarg_doc("bool, значение по умолчанию: rcParams["text.usetex"] (по умолчанию: False)") def set_usetex(self, usetex):

См. также

matplotlib.artist.kwdoc