Документирование классов для Sphinx
sphinx — отличный инструмент для отображения документации в формате HTML. В этом упражнении вы напишете строку документации для класса, которую сможет использовать sphinx.
Обратите внимание: ваша строка документации должна совпадать с решением точно. Если у вас несколько раз не получается, попробуйте сбросить пример кода и начать заново.
Это упражнение является частью курса
Принципы разработки программного обеспечения на Python
Инструкции к упражнению
- С помощью
importподключите классDocumentfromпакетаtext_analyzerдля использования в определении класса. - Заполните строку документации, описывающую параметры метода
__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()