Sphinx 用にクラスをドキュメント化する
sphinx はドキュメントを HTML としてレンダリングできる優れたツールです。この演習では、sphinx で活用できるクラス用のドックストリングを書きます。
提出するドックストリングは模範解答と「完全に」一致している必要があります。何度か間違えてしまう場合は、サンプルコードをリセットして最初からやり直すとよいでしょう。
この演習はコースの一部です
Pythonで学ぶSoftware Engineeringの原則
演習の手順
- クラス定義で使用するために、
text_analyzerパッケージからDocumentクラスをimportします。 __init__メソッドのパラメータに関するドックストリングの行を完成させます。SocialMediaクラスの属性（インスタンス変数）のドキュメントを記述して、ドックストリングを完成させます。
実践的なインタラクティブ演習
このサンプルコードを完成させて、この演習に挑戦してみましょう。
____
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()