ドキュメンテーション文字列（docstring）を書く
docstring の利点について学んだところです。この演習では、Sphinx のようなドキュメンテーション生成ツールで利用できる docstring を実際に書いてみます。
提出する docstring は解答と「完全に」一致している必要があります。何度か不正解になる場合は、サンプルコードにリセットして、最初からやり直すことをおすすめします。
この演習はコースの一部です
Pythonで学ぶSoftware Engineeringの原則
演習の手順
- パラメータを記述する docstring の部分を完成させてください。
- 返り値の説明を記述する docstring の部分を完成させてください。
- docstring 内の使用例を完成させてください。
実践的なインタラクティブ演習
このサンプルコードを完成させて、この演習に挑戦してみましょう。
# 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)