Menulis docstring
Kita baru saja mempelajari beberapa manfaat docstring. Pada latihan ini, Anda akan berlatih menulis docstring yang dapat dimanfaatkan oleh pembuat dokumentasi seperti Sphinx.
Perhatikan bahwa pengiriman docstring Anda harus sama persis dengan solusinya. Jika Anda beberapa kali masih salah, sebaiknya segarkan kode contoh dan mulai dari awal.
Latihan ini adalah bagian dari kursus
Prinsip Rekayasa Perangkat Lunak di Python
Petunjuk latihan
- Lengkapi bagian docstring yang mendokumentasikan parameter.
- Lengkapi bagian docstring yang menjelaskan nilai kembalian.
- Lengkapi contoh penggunaan fungsi pada docstring.
Latihan interaktif praktis
Cobalah latihan ini dengan menyelesaikan kode contoh berikut.
# 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)