Scrierea docstring-urilor
Tocmai am aflat câteva lucruri despre beneficiile docstring-urilor. În acest exercițiu, vei exersa scrierea de docstring-uri care pot fi utilizate de un generator de documentație precum Sphinx.
Reține că docstring-ul trimis trebuie să corespundă exact cu soluția. Dacă îți iese greșit de mai multe ori, ar putea fi o idee bună să resetezi codul exemplu și să o iei de la capăt.
Acest exercițiu face parte din cursul
Principii de inginerie software în Python
Instrucțiuni pentru exercițiu
- Completează secțiunile din docstring care documentează parametrii.
- Completează secțiunea din docstring care descrie valoarea returnată.
- Completează exemplul de utilizare a funcției din docstring.
Exercițiu interactiv practic
Încearcă acest exercițiu completând acest cod de exemplu.
# 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)