matplotlib.docstring

Aufmerksamkeit

Dieses Modul gilt als intern.

Seine Verwendung ist veraltet und wird in einer zukünftigen Version entfernt.

Klasse matplotlib._docstring. Substitution ( * args , ** kwargs )

Basen:object

Ein Dekorator, der eine %-Substitution an der Dokumentzeichenfolge eines Objekts durchführt.

Dieser Decorator sollte robust sein, auch wenn obj.__doc__er None ist (zB wenn -OO an den Interpreter übergeben wurde).

Verwendung: Konstruieren Sie eine docstring.Substitution mit einer Sequenz oder einem Wörterbuch, das für die Durchführung der Substitution geeignet ist; schmücken Sie dann eine passende Funktion mit dem konstruierten Objekt, zB:

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"

Man kann auch Positionsargumente verwenden:

sub_first_last_names = Substitution('Edgar Allen', 'Poe')

@sub_first_last_names
def some_function(x):
    "%s %s wrote the Raven"

update ( * args , ** kwargs )

Update self.params(muss ein Diktat sein) mit den bereitgestellten Argumenten.

matplotlib._docstring. kopieren ( Quelle )

Kopieren Sie eine Dokumentzeichenfolge aus einer anderen Quellfunktion (falls vorhanden).