matplotlib.docstring

Atenção

Este módulo é considerado interno.

Seu uso está obsoleto e será removido em uma versão futura.

classe matplotlib._docstring. Substituição ( * args , ** kwargs )

Bases:object

Um decorador que executa %-substituição na docstring de um objeto.

Este decorador deve ser robusto mesmo se obj.__doc__for None (por exemplo, se -OO foi passado para o interpretador).

Uso: construir uma docstring.Substitution com uma sequência ou dicionário adequado para realizar a substituição; em seguida, decore uma função adequada com o objeto construído, por exemplo:

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"

Pode-se também usar argumentos posicionais:

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

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

atualização ( * args , ** kwargs )

Atualize self.params(que deve ser um dict) com os args fornecidos.

matplotlib._docstring. copiar ( fonte )

Copie uma docstring de outra função de origem (se presente).