Documentando classes para o Sphinx
sphinx é uma ótima ferramenta para renderizar a documentação como HTML. Neste exercício, você escreverá uma docstring para uma classe que pode ser aproveitada pelo site sphinx.
Observe que o envio de sua docstring deve corresponder exatamente à solução. Se você errar várias vezes, pode ser uma boa ideia atualizar o código de exemplo e começar de novo.
Este exercício faz parte do curso
Princípios de engenharia de software em Python
Instruções de exercício
importa classeDocumentfromo pacotetext_analyzerpara uso na definição da classe.- Complete a linha da documentação que trata dos parâmetros do método
__init__. - Complete a docstring preenchendo a documentação dos atributos ou "variáveis de instância" da classe
SocialMedia.
Exercício interativo prático
Experimente este exercício preenchendo este código de exemplo.
____
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()