Skriva docstrings
Du har just lärt dig om fördelarna med docstrings. I den här övningen får du öva på att skriva docstrings som kan användas av ett dokumentationsverktyg som Sphinx.
Observera att din docstring måste stämma överens med lösningen exakt. Om du märker att det går fel flera gånger kan det vara en bra idé att återställa exempelkoden och börja om.
Den här övningen är en del av kursen
Mjukvaruutvecklingsprinciper i Python
Övningsinstruktioner
- Fyll i de delar av docstringen som dokumenterar parametrarna.
- Fyll i den del av docstringen som beskriver returvärdet.
- Fyll i exempelanvändningen av funktionen i docstringen.
Interaktiv övning med praktiskt arbete
Testa den här övningen genom att slutföra den här exempelkoden.
# 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)