Adloun

Documenter une fonction

Exercice supplémentaire · niveau 2 · sciences numériques et technologie (seconde), chapitre 5 — Les fonctions · Définir et appeler une fonction

Énoncé

Une chaîne placée en première ligne du corps d'une fonction en devient la documentation. L'ajouter à une fonction imc(masse, taille) calculant l'indice de masse corporelle, puis afficher help(imc).

Corrigé

def imc(masse, taille):
    """Renvoie l'indice de masse corporelle.

    masse : en kilogrammes
    taille : en mètres
    """
    return masse / taille ** 2

print(imc(70, 1.75))   # 22.857142857142858
help(imc)

help affiche la documentation, et la même chaîne est accessible par imc.__doc__.

Ce qui mérite d'y figurer, ce sont les choses que le code ne dit pas : ici, les unités. Rien dans masse / taille ** 2 n'indique qu'il faut des mètres et non des centimètres — et c'est exactement le genre d'ambiguïté qui a fait perdre une sonde martienne en 1999.

Les autres exercices de ce chapitre Le cours du chapitre

Un blocage sur cet exercice ? Le tuteur d'Adloun guide par questions, sans donner la réponse.