Scrivere docstring
Abbiamo appena visto alcuni dei benefici delle docstring. In questo esercizio, metterai in pratica la scrittura di docstring che possono essere usate da un generatore di documentazione come Sphinx.
Nota che la docstring che invii deve corrispondere alla soluzione in modo esatto. Se sbagli più volte, può essere utile ripristinare il codice di esempio e ricominciare da capo.
Questo esercizio fa parte del corso
Principi di Ingegneria del Software in Python
Istruzioni dell'esercizio
- Completa le parti della docstring che documentano i parametri.
- Completa la parte della docstring che descrive il valore di ritorno.
- Completa l'esempio di utilizzo della funzione nella docstring.
Esercizio pratico interattivo
Prova a risolvere questo esercizio completando il codice di esempio.
# 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)