Написание строк документации
Мы уже познакомились с преимуществами строк документации. В этом упражнении вы попрактикуетесь в их написании — так, чтобы их мог использовать генератор документации, например Sphinx.
Обратите внимание: ваша строка документации должна точно совпадать с эталонным решением. Если с первых нескольких попыток не получается — попробуйте сбросить пример кода и начать заново.
Это упражнение является частью курса
Принципы разработки программного обеспечения на 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)