Escrevendo docstrings
Acabamos de aprender um pouco sobre os benefícios das docstrings. Neste exercício, você praticará a escrita de docstrings que podem ser utilizados por um gerador de documentação como o Sphinx.
Observe que o envio de sua docstring deve corresponder exatamente à solução. Se você errar várias vezes, pode ser uma boa ideia atualizar o código de exemplo e começar de novo.
Este exercício faz parte do curso
Princípios de engenharia de software em Python
Instruções de exercício
- Complete as partes da docstring que documentam os parâmetros.
- Complete a parte da cadeia de documentos que descreve o valor de retorno.
- Complete o exemplo de uso da função na docstring.
Exercício interativo prático
Experimente este exercício preenchendo este código de exemplo.
# 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)