Documentación de clases para Sphinx
sphinx es una herramienta excelente para convertir documentación a formato HTML. En este ejercicio, escribirás una cadena de documentación para una clase que puede ser aprovechada por sphinx.
Ten en cuenta que tu envío de docstring debe coincidir exactamente con la solución. Si te das cuenta de que te equivocas 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 de software en Python
Instrucciones del ejercicio
importla claseDocumentfromel paquetetext_analyzerpara su uso en la definición de la clase.- Completa la línea de la cadena de documentación que trata sobre los parámetros del método
__init__. - Completa la cadena de documentación rellenando la documentación de los atributos o «variables de instancia» de la clase
SocialMedia.
Ejercicio interactivo práctico
Prueba este ejercicio y completa el 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()