`matplotlib.docstring`#

注意

此模块被视为内部模块。

它的使用已被弃用，并将在未来的版本中移除。

class matplotlib._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"

update(*args, **kwargs)[源代码][源代码]#: 使用提供的参数更新 ``self.params``（必须是一个字典）。

matplotlib._docstring.copy(source)[源代码][源代码]#: 从另一个源函数（如果存在）复制文档字符串。

matplotlib._docstring.kwarg_doc(text)[源代码][源代码]#

用于定义艺术家属性 kwdoc 文档的装饰器。

这个装饰器可以应用于艺术家属性设置方法。给定的文本存储在方法的私有属性 _kwarg_doc 中。它用于覆盖艺术家 kwdoc 列表 中的自动生成文档。kwdoc 列表用于记录当它们是艺术家属性时的 **kwargs。例如，参见 Axes.text 中的 **kwargs 部分。

文本应包含支持的类型，以及适用的默认值（如果有），例如：

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

参见

matplotlib.artist.kwdoc

matplotlib.docstring#

`matplotlib.docstring`#