Escrevendo docstrings claras e informativas

Docstrings são strings de documentação que explicam o funcionamento de funções, classes e módulos.

Exemplo:

python

Copy

def soma(a, b):
    """
    Retorna a soma de dois números.

    Parâmetros:
    a (int): Primeiro número.
    b (int): Segundo número.

    Retorna:
    int: Soma de a e b.
    """
    return a + b