Dokumentowanie klas dla Sphinx

sphinx to świetne narzędzie do renderowania dokumentacji w postaci HTML. W tym ćwiczeniu napiszesz docstring dla klasy, który będzie w pełni wykorzystywany przez sphinx.

Zwróć uwagę, że twój docstring musi być dokładnie zgodny z rozwiązaniem. Jeśli kilka razy nie uda ci się uzyskać poprawnego wyniku, warto zresetować przykładowy kod i zacząć od początku.

To ćwiczenie jest częścią kursu

Zasady inżynierii oprogramowania w Pythonie

Zobacz kurs

Instrukcje do ćwiczenia

Za pomocą import zaimportuj klasę Document from pakietu text_analyzer, aby użyć jej w definicji klasy.
Uzupełnij linię docstringa dotyczącą parametrów metody __init__.
Dokończ docstring, wypełniając dokumentację atrybutów, czyli „zmiennych instancji" klasy SocialMedia.

Interaktywne ćwiczenie praktyczne

Spróbuj tego ćwiczenia, uzupełniając ten przykładowy kod.

____

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

Edytuj i uruchom kod