Documentación de clases para Sphinx
sphinx
es una gran herramienta para presentar la documentación en HTML. En este ejercicio, escribirás un docstring para una clase que puede ser aprovechado por sphinx
.
Tenga en cuenta que su docstring debe coincidir exactamente con la solución. Si se equivoca varias veces, puede ser una buena idea actualizar el código de ejemplo y empezar de nuevo.
Este ejercicio forma parte del curso
Principios de ingeniería del software en Python
Instrucciones de ejercicio
import
la claseDocument
from
el paquetetext_analyzer
para su uso en la definición de la clase.- Complete la línea del docstring relativa a los parámetros del método
__init__
. - Complete el docstring rellenando la documentación de los atributos o "variables de instancia" de la clase
SocialMedia
.
Ejercicio interactivo práctico
Pruebe este ejercicio completando este código de muestra.
____
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()