Docstrings schreiben
Wir haben gerade etwas über die Vorteile von Docstrings gelernt. In dieser Übung übst du das Schreiben von Docstrings, die von einem Dokumentationsgenerator wie Sphinx genutzt werden können.
Beachte, dass deine Docstring-Eingabe der Musterlösung exakt entsprechen muss. Wenn es mehrmals nicht klappt, ist es eine gute Idee, den Beispielcode zu aktualisieren und neu zu beginnen.
Diese Übung ist Teil des Kurses
<Kurs>Grundlagen der Softwareentwicklung in Python</Kurs>Übungsanweisungen
- Vervollständige die Teile des Docstrings, die die Parameter dokumentieren.
- Vervollständige den Teil des Docstrings, der den Rückgabewert beschreibt.
- Vervollständige das Beispiel zur Funktionsverwendung im Docstring.
Interaktive praktische Übung
Versuche dich an dieser Übung, indem du diesen Beispielcode vervollständigst.
# 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)