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, exploitable par sphinx.
Notez que votre docstring doit correspondre exactement à la solution. Si vous vous trompez plusieurs fois, il peut être judicieux de réinitialiser l'exemple de code et de repartir de zéro.
Cet exercice fait partie du cours
<cours>Principes de génie logiciel en Python</cours>Instructions de l’exercice
- Importez la classe
Documentdepuis le packagetext_analyzerpour l'utiliser dans la définition de la classe. - Complétez la ligne de la docstring qui décrit les paramètres de la méthode
__init__. - Terminez la docstring en complétant 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()