Dokumentace tříd pro Sphinx

sphinx je skvělý nástroj pro generování dokumentace ve formátu HTML. V tomto cvičení napíšeš docstring pro třídu, který bude plně kompatibilní s sphinx.

Poznámka: tvůj docstring musí přesně odpovídat vzorovému řešení. Pokud se ti to opakovaně nedaří, může být dobré obnovit ukázkový kód a začít znovu.

Toto cvičení je součástí kurzu

Principy softwarového inženýrství v Pythonu

Zobrazit kurz

Pokyny k cvičení

Pomocí import načti třídu Document from balíčku text_analyzer, aby ji bylo možné použít v definici třídy.
Doplň řádek docstringu týkající se parametrů metody __init__.
Dokonči docstring vyplněním dokumentace pro atributy neboli 'instance variables' třídy SocialMedia.

Interaktivní cvičení na vyzkoušení si v praxi

Vyzkoušejte si toto cvičení dokončením tohoto ukázkového kódu.

____

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()

Upravit a spustit kód