Psaní docstringů
Právě jsme si probrali, jaké výhody docstringy přinášejí. V tomto cvičení si procvičíš jejich psaní ve formátu, který dokáže zpracovat generátor dokumentace jako Sphinx.
Pozor: tvůj docstring musí přesně odpovídat vzorovému řešení. Pokud se ti to opakovaně nedaří, může být dobré obnovit ukázkový kód a začít znovu.
Toto cvičení je součástí kurzu
Principy softwarového inženýrství v Pythonu
Pokyny k cvičení
- Doplň části docstringu, které dokumentují parametry.
- Doplň část docstringu popisující návratovou hodnotu.
- Doplň příklad použití funkce v docstringu.
Interaktivní cvičení na vyzkoušení si v praxi
Vyzkoušejte si toto cvičení dokončením tohoto ukázkového kódu.
# 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)