Documenter une fonction

Voici une fonction:

def is_even(nbr):
    return nbr % 2 == 0

Que fait cette fonction ? Vous ne l'avez pas écrite ou il y a longtemps...Il manque de la documentation.

Voici la même fonction documentée:

def is_even(nbr):
    """
    Cette fonction teste si un nombre est pair.
   L'argument nbr peut être un entier ou un nombre à virgule, si nbr est pair la fonction renvoie True, si nbr est impaire la fonction renvoie False.
    """
    return nbr % 2 == 0

à faire vous même:

copier cette fonction sous Pyzo, tester la .

Puis dans la console entrer la commande

help (is_even)

vous aurez la documentation de vote fonction .

Il est important de bien commenter son programme et de documenter les fonctions, cela permet de reprendre un code que l'on a écrit il y a longtemps et cela facilite la compréhension de votre code par un autre programmeur ( par exemple en projet à plusieurs codeurs).