matplotlib._docstring

classmatplotlib._docstring.Substitution(*args, **kwargs)[исходный код]

Базовые классы: 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"

matplotlib._docstring.copy(source)[исходный код]

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

matplotlib._docstring.kwarg_doc(text)[исходный код]

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

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

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

@_docstring.kwarg_doc("bool, default: rcParams["text.usetex"] (default: False)") def set_usetex(self, usetex):

См. также

matplotlib.artist.kwdoc