ПочатиПочніть безкоштовно

Документування класів для Sphinx

sphinx — чудовий інструмент для відтворення документації у форматі HTML. У цій вправі ви напишете докстрінг для класу, який зможе використати sphinx.

Зверніть увагу, що ваш докстрінг має повністю збігатися з розв'язком. Якщо кілька разів не вдається, варто скинути зразок коду та почати спочатку.

Ця вправа є частиною курсу

Принципи Software Engineering у Python

Переглянути курс

Інструкції до вправи

  • import клас Document from пакета 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()
Редагувати та запускати код