matplotlib.docstring

Attention

Ce module est considéré comme interne.

Son utilisation est obsolète et sera supprimée dans une future version.

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

Socles :object

Un décorateur qui effectue %-substitution sur la docstring d'un objet.

Ce décorateur doit être robuste même s'il obj.__doc__vaut None (par exemple, si -OO a été passé à l'interpréteur).

Utilisation : construire une docstring.Substitution avec une séquence ou un dictionnaire adapté pour effectuer la substitution ; décorez ensuite une fonction appropriée avec l'objet construit, par exemple :

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"

On peut aussi utiliser des arguments positionnels :

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

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

mettre à jour ( * args , ** kwargs )

Update self.params(qui doit être un dict) avec les arguments fournis.

matplotlib._docstring. copier ( source )

Copiez une docstring à partir d'une autre fonction source (le cas échéant).