matplotlib.docstring

注意力

这个模块被认为是内部的。

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

类 matplotlib._docstring。替换( * args , ** kwargs )

基地：object

对对象的文档字符串执行 %-substitution 的装饰器。

这个装饰器应该是健壮的，即使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"

更新( * args , ** kwargs )

使用提供的参数更新self.params（必须是字典）。

matplotlib._docstring。复制(来源)

从另一个源函数（如果存在）复制文档字符串。