Documentarea claselor pentru Sphinx
sphinx este un instrument excelent pentru a genera documentație sub formă de HTML. În acest exercițiu, vei scrie un docstring pentru o clasă care poate fi valorificată de sphinx.
Reține că docstring-ul trimis trebuie să corespundă exact cu soluția. Dacă greșești de mai multe ori, ar 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
importă clasaDocumentfrompachetultext_analyzerpentru a o folosi în definiția clasei.- Completează linia din docstring care descrie parametrii metodei
__init__. - Finalizează docstring-ul completând documentația pentru atributele sau „variabilele de instanță" ale clasei
SocialMedia.
Exercițiu interactiv practic
Încearcă acest exercițiu completând acest cod de exemplu.
____
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()