Dokumentera klasser för Sphinx

sphinx är ett utmärkt verktyg för att rendera dokumentation som HTML. I den här övningen skriver du en docstring för en klass som kan utnyttjas av sphinx.

Observera att din docstring måste matcha lösningen exakt. Om du får fel flera gånger kan det vara en bra idé att återställa exempelkoden och börja om.

Den här övningen är en del av kursen

Mjukvaruutvecklingsprinciper i Python

Visa kurs

Övningsinstruktioner

importera klassen Document from paketet text_analyzer för användning i klassdefinitionen.
Fyll i raden i docstringen som beskriver parametrarna för metoden __init__.
Slutför docstringen genom att fylla i dokumentationen för attributen, eller instansvariablerna, i klassen SocialMedia.

Interaktiv övning med praktiskt arbete

Testa den här övningen genom att slutföra den här exempelkoden.

____

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

Redigera och kör kod