Escribir cadenas de documentación
Acabamos de aprender algunas cosas sobre las ventajas de las cadenas de documentación. En este ejercicio, practicarás escribiendo cadenas de documentación que pueden ser utilizadas por un generador de documentación como Sphinx.
Ten en cuenta que tu envío de docstring debe coincidir exactamente con la solución. Si te das cuenta de que te equivocas 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 de software en Python
Instrucciones del ejercicio
- Completa las partes de la cadena de documentación que documentan los parámetros.
- Completa la parte de la cadena de documentación que describe el valor de retorno.
- Completa el ejemplo de uso de la función en la cadena de documentación.
Ejercicio interactivo práctico
Prueba este ejercicio y completa el 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)