Pisanie docstringów
Poznaliśmy już zalety docstringów. W tym ćwiczeniu przećwiczysz pisanie docstringów, które mogą być wykorzystywane przez generatory dokumentacji, takie jak Sphinx.
Zwróć uwagę, że twój docstring musi dokładnie odpowiadać rozwiązaniu. Jeśli kilka razy nie wychodzi, warto zresetować przykładowy kod i zacząć od nowa.
To ćwiczenie jest częścią kursu
Zasady inżynierii oprogramowania w Pythonie
Instrukcje do ćwiczenia
- Uzupełnij fragmenty docstringa dokumentujące parametry.
- Uzupełnij fragment docstringa opisujący wartość zwracaną.
- Uzupełnij przykładowe użycie funkcji w docstringu.
Interaktywne ćwiczenie praktyczne
Spróbuj tego ćwiczenia, uzupełniając ten przykładowy kod.
# 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)