Escribir docstrings
Acabamos de conocer algunas de las ventajas de los docstrings. En este ejercicio, practicarás escribiendo docstrings que pueden ser utilizados por un generador de documentación como Sphinx.
Tenga en cuenta que su docstring debe coincidir exactamente con la solución. Si se equivoca varias veces, puede ser una buena idea actualizar el código de ejemplo y empezar de nuevo.
Este ejercicio forma parte del curso
Principios de ingeniería del software en Python
Instrucciones de ejercicio
- Complete las partes de la docstring que documentan los parámetros.
- Completa la parte del docstrip que describe el valor de retorno.
- Completa el ejemplo de uso de la función en el docstring.
Ejercicio interactivo práctico
Pruebe este ejercicio completando este código de muestra.
# 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)