Python Eficaz

it's a set.
Args:
word: String of the target word.
dictionary: Container with all strings that
are known to be actual words.
Returns:
List of anagrams that were found. Empty if
none were found.
"""
# ...
Há ainda alguns casos especiais a considerar quando escrevemos docstrings para
funções:
• Se a função não pede nenhum argumento e possui um valor de retorno muito
simples, uma única frase descrevendo esse comportamento é mais que
suficiente.
• Se a função não retornar nada, é melhor suprimir qualquer menção ao valor
de retorno em vez de dizer “não retorna nada” (em inglês, “returns None.” 2 ).
• Algumas funções levantam exceções durante a operação normal e não apenas
em caso de erro; se a sua função for desse tipo, documente o fato; se não for,
nem mencione.
• Caso a função aceite um número variável de argumentos (consulte o Item 18:
“Reduza a poluição visual com argumentos opcionais”) ou argumentos por
palavra-chave (consulte o Item 19: “Implemente comportamento opcional
usando palavras-chave como argumentos”), use *args e **kwargs na lista de
argumentos documentados para descrever seu propósito.
• Se a função tiver argumentos com valores default, os valores devem ser
mencionados e claramente identificados como default (consulte o Item 20:
“Use None e docstrings para especificar argumentos default dinâmicos e
específicos”).
• Nas funções geradoras (consulte o Item 16: “Prefira geradores em vez de
retornar listas”), a docstring deve descrever o que o gerador produz (com
www.full-ebook.com