Написання докстрингів
Ми щойно дізналися про переваги докстрингів. У цій вправі ви попрактикуєтеся писати докстринги, які може використати генератор документації на кшталт Sphinx.
Зверніть увагу: ваш докстринг має повністю збігатися з розв'язком. Якщо кілька разів не виходить, радимо оновити зразок коду й почати спочатку.
Ця вправа є частиною курсу
Принципи Software Engineering у Python
Інструкції до вправи
- Доповніть частини докстринга, які документують параметри.
- Допишіть частину докстринга з описом значення, що повертається.
- Завершіть приклад використання функції в докстрингу.
Інтерактивна практична вправа
Спробуйте виконати цю вправу, доповнивши цей зразок коду.
# 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)