Rédiger des docstrings
Nous venons de voir les avantages des docstrings. Dans cet exercice, vous allez vous entraîner à rédiger des docstrings utilisables par un générateur de documentation comme Sphinx.
Notez que votre docstring doit correspondre exactement à la solution. Si vous faites plusieurs essais infructueux, il peut être judicieux de réinitialiser l’exemple de code et de repartir de zéro.
Cet exercice fait partie du cours
<cours>Principes d’ingénierie logicielle en Python</cours>Instructions de l’exercice
- 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.
Exercice interactif pratique
Essayez cet exercice en complétant ce code d’exemple.
# Complete the function's docstring
def tokenize(text, regex=r'[a-zA-z]+'):
"""Split text into tokens using a regular expression
:____ text: text to be tokenized
:param ____: regular expression used to match tokens using re.findall
:____: a list of resulting tokens
>>> ____('the rain in spain')
____
"""
return re.findall(regex, text, flags=re.IGNORECASE)
# Print the docstring
help(tokenize)