1. Learn
    2. /
  2. Courses
    3. /
  3. Principes d'ingénierie logicielle en Python
Connected

Exercise

Rédiger des docstrings

Vous venez de voir les avantages des docstrings. Dans cet exercice, vous pratiquerez l'écriture de docstrings qui peuvent être utilisées par un générateur de documentation comme Sphinx.

Notez que votre docstring doit correspondre exactement à la solution. Si vous faites plusieurs erreurs d'affilée, il peut être judicieux de réinitialiser l'exemple de code et de reprendre depuis le début.

Instructions

100 XP
  • Complétez les parties de la docstring qui documentent les paramètres.
  • Complétez la partie de la docstring qui décrit la valeur de retour.
  • Complétez l'exemple d'utilisation de la fonction dans la docstring.