matplotlib.docstring

Atención

Este módulo se considera interno.

Su uso está en desuso y se eliminará en una versión futura.

clase matplotlib._docstring. Sustitución ( * args , ** kwargs )

Bases:object

Un decorador que realiza % de sustitución en la cadena de documentación de un objeto.

Este decorador debe ser robusto incluso si obj.__doc__es Ninguno (por ejemplo, si se pasó -OO al intérprete).

Uso: construye una cadena de documentación. Sustitución con una secuencia o diccionario adecuado para realizar la sustitución; luego decora una función adecuada con el objeto construido, por ejemplo:

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"

También se pueden usar argumentos posicionales:

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

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

actualización ( * argumentos , ** kwargs )

Actualice self.params(que debe ser un dictado) con los argumentos proporcionados.

matplotlib._docstring. copiar ( fuente )

Copie una cadena de documentos de otra función fuente (si está presente).