Docstrings schrijven
We hebben zojuist geleerd wat de voordelen van docstrings zijn. In deze oefening ga je docstrings schrijven die gebruikt kunnen worden door een documentatiegenerator zoals Sphinx.
Let op: je docstring-inzending moet exact overeenkomen met de oplossing. Lukt het meerdere keren niet, dan is het een goed idee om de voorbeeldcode te verversen en opnieuw te beginnen.
Deze oefening maakt deel uit van de cursus
Software-engineeringprincipes in Python
Oefeninstructies
- Vul de onderdelen van de docstring in die de parameters documenteren.
- Vul het gedeelte van de docstring in dat de geretourneerde waarde beschrijft.
- Maak het voorbeeld van het gebruik van de functie in de docstring af.
Praktische interactieve oefening
Probeer deze oefening eens door deze voorbeeldcode in te vullen.
# 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)