Escrevendo docstrings
Acabamos de aprender um pouco sobre os benefícios das docstrings. Neste exercício, você vai praticar escrever docstrings que podem ser usadas por um gerador de documentação como o Sphinx.
Lembre-se de que o envio da sua string de documentação precisa ser igualzinho à solução. Se você perceber que está errando várias vezes, pode ser uma boa ideia atualizar o código de exemplo e começar de novo.
Este exercicio faz parte do curso
Princípios de Engenharia de Software em Python
Instruções do exercicio
- Preencha as partes da string de documentação que explicam os parâmetros.
- Preencha a parte da string de documentação que fala sobre o valor de retorno.
- Complete o exemplo de uso da função na string de documentação.
exercicio interativo prático
Tente este exercicio completando 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)