Documentando classes para o Sphinx
sphinx é uma ótima ferramenta para renderizar documentação como HTML. Neste exercício, você vai escrever uma string de documentação para uma classe que pode ser aproveitada por sphinx.
Lembre-se de que o envio da sua string de documentação precisa ser igualzinho à solução. Se você perceber que está errando 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 do exercício
importa classeDocumentfromo pacotetext_analyzerpara usar na definição da classe.- Complete a linha da string de documentação que fala sobre os parâmetros do método `
__init__`. - Complete a string de documentação preenchendo a documentação dos atributos ou “variáveis de instância” da classe
SocialMedia.
Exercício interativo prático
Experimente este exercício completando 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()