Documentare le classi per Sphinx
sphinx è uno strumento eccellente per generare la documentazione in HTML. In questo esercizio scriverai una docstring per una classe che potrà essere utilizzata da sphinx.
Nota che la docstring che invii deve coincidere esattamente con la soluzione. Se sbagli più volte, può essere una buona idea ripristinare il codice di esempio e ricominciare da capo.
Questo esercizio fa parte del corso
Principi di Ingegneria del Software in Python
Istruzioni dell'esercizio
- Esegui l'
importdella classeDocumentfromil pacchettotext_analyzerper usarla nella definizione della classe. - Completa la riga della docstring relativa ai parametri del metodo
__init__. - Completa la docstring compilando la documentazione per gli attributi, o "variabili di istanza", della classe
SocialMedia.
Esercizio pratico interattivo
Prova a risolvere questo esercizio completando il codice di esempio.
____
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()