Mendokumentasikan kelas untuk Sphinx
sphinx adalah alat yang sangat baik untuk merender dokumentasi menjadi HTML. Pada latihan ini, Anda akan menulis docstring untuk sebuah kelas yang dapat dimanfaatkan oleh sphinx.
Perhatikan bahwa kiriman docstring Anda harus sama persis dengan solusi. Jika Anda beberapa kali masih salah, ada baiknya menyegarkan kode contoh dan memulai kembali.
Latihan ini adalah bagian dari kursus
Prinsip Rekayasa Perangkat Lunak di Python
Petunjuk latihan
importkelasDocumentfrompakettext_analyzeruntuk digunakan dalam definisi kelas.- Lengkapi baris docstring yang membahas parameter metode
__init__. - Lengkapi docstring dengan mengisi dokumentasi untuk atribut atau 'variabel instans' dari kelas
SocialMedia.
Latihan interaktif praktis
Cobalah latihan ini dengan menyelesaikan kode contoh berikut.
____
class SocialMedia(Document):
"""Analyze text data from social media
____ social media text to analyze
:____: Counter object containing counts of hashtags used in text
:____: Counter object containing counts of @mentions used in text
"""
def __init__(self, text):
Document.__init__(self, text)
self.hashtag_counts = self._count_hashtags()
self.mention_counts = self._count_mentions()