Klassen für Sphinx dokumentieren

sphinx ist ein großartiges Tool, um Dokumentation als HTML zu rendern. In dieser Übung schreibst du eine Docstring für eine Klasse, die von sphinx genutzt werden kann.

Beachte, dass deine eingereichte Docstring exakt mit der Lösung übereinstimmen muss. Wenn es mehrmals nicht klappt, ist es eine gute Idee, den Beispielcode zu aktualisieren und neu zu beginnen.

Diese Übung ist Teil des Kurses

<Kurs>Grundlagen der Softwareentwicklung in Python</Kurs>

Kurs ansehen

Übungsanweisungen

importiere die Klasse Document from dem Paket text_analyzer zur Verwendung in der Klassendefinition.
Vervollständige die Zeile der Docstring, die die Parameter der __init__-Methode behandelt.
Schließe die Docstring ab, indem du die Dokumentation für die Attribute bzw. „Instanzvariablen“ der Klasse SocialMedia ausfüllst.

Interaktive praktische Übung

Versuche dich an dieser Übung, indem du diesen Beispielcode vervollständigst.

____

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

Code bearbeiten und ausführen