matplotlib.docstring

注意

このモジュールは内部と見なされます。

その使用は推奨されておらず、将来のバージョンで削除される予定です。

クラス matplotlib._docstring. Substitution ( * args , ** kwargs )

拠点:object

オブジェクトの docstring で %-substitution を実行するデコレータ。

このデコレータは、None であっても堅牢である必要がありますobj.__doc__(たとえば、-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. コピー(ソース)

別のソース関数から docstring をコピーします (存在する場合)。