Python Eficaz

da classe. Deve também haver orientação sobre como criar subclasses que
interajam com atributos protegidos (consulte o Item 27: “Prefira atributos
públicos em vez de privativos”) e os métodos da superclasse.
O exemplo a seguir mostra a docstring de uma classe:
class Player(object):
"""Represents a player of the game.
Subclasses may override the 'tick' method to provide
custom animations for the player's movement depending
on their power level, etc.
Public attributes:
- power: Unused power-ups (float between 0 and 1).
- coins: Coins found during the level (integer).
"""
# ...
Documentando funções
Todo método ou função públicos precisam, necessariamente, ter uma docstring.
Novamente, os moldes são mais ou menos os mesmos das classes e módulos. A
primeira linha é a descrição, em uma frase, do que a função faz. O parágrafo
seguinte descreve qualquer comportamento específico e os argumentos da
função. Os valores de retorno esperados devem também ser descritos. Quaisquer
exceções que os chamadores devam tratar como parte da interface da função
devem ser explicados.
O exemplo a seguir mostra a docstring de uma função:
def find_anagrams(word, dictionary):
"""Find all anagrams for a word.
This function only runs as fast as the test for
membership in the 'dictionary' container. It will
be slow if the dictionary is a list and fast if
www.full-ebook.com