Documenter des classes pour Sphinx

sphinx est un excellent outil pour générer de la documentation en HTML. Dans cet exercice, vous allez écrire une docstring pour une classe qui pourra être exploitée par sphinx.

Notez que la docstring que vous soumettrez doit correspondre exactement à la solution. Si vous obtenez des erreurs à plusieurs reprises, il peut être utile de réinitialiser l'exemple de code et de repartir à neuf.

Cette activité fait partie du cours

Principes d'ingénierie logicielle en Python

Voir le cours

Instructions de l’exercice

importez la classe Document from le progiciel text_analyzer pour l'utiliser dans la définition de la classe.
Complétez la ligne de la docstring qui traite des paramètres de la méthode __init__.
Terminez la docstring en remplissant la documentation des attributs, ou « variables d'instance », de la classe SocialMedia.

Exercice interactif pratique

Essayez cet exercice en complétant ce code d’exemple.

____

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

Modifier et exécuter le code