Klassen documenteren voor Sphinx
sphinx is een geweldige tool om documentatie als HTML te genereren. In deze oefening schrijf je een docstring voor een klasse die gebruikt kan worden door sphinx.
Let op: je docstring-inzending moet exact overeenkomen met de oplossing. Als het meerdere keren misgaat, is het verstandig om de voorbeeldcode te vernieuwen en opnieuw te beginnen.
Deze oefening maakt deel uit van de cursus
Software-engineeringprincipes in Python
Oefeninstructies
importdeDocument-klassefromhettext_analyzer-pakket om te gebruiken in de klassedefinitie.- Maak de regel in de docstring af die gaat over de parameters van de
__init__-methode. - Maak de docstring af door de documentatie in te vullen voor de attributen of 'instancevariabelen' van de
SocialMedia-klasse.
Praktische interactieve oefening
Probeer deze oefening eens door deze voorbeeldcode in te vullen.
____
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()