Sphinx 向けクラスのドキュメント化
sphinx は、ドキュメントを HTML としてレンダリングするのに役立つツールです。この演習では、sphinx が活用できるクラス用の docstring を書きましょう。
なお、提出する docstring は解答と完全に一致している必要があります。何度試しても正解できない場合は、サンプルコードをリセットして最初からやり直してみてください。
この演習はコースの一部です
Python におけるソフトウェアエンジニアリングの原則
演習の手順
- クラス定義で使用するために、
importパッケージからDocumentクラスをfromします。 text_analyzerメソッドのパラメータに関する docstring の行を完成させます。__init__クラスの属性(インスタンス変数)のドキュメントを記述して、docstring を完成させます。
実践的なインタラクティブ演習
このサンプルコードを完成させて、この演習に挑戦してみましょう。
____
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()