Sphinx için sınıfları belgeleme
sphinx, belgeleri HTML olarak üretmek için harika bir araçtır. Bu egzersizde, sphinx tarafından kullanılabilecek bir sınıf için docstring yazacaksın.
Docstring yanıtının çözümle birebir aynı olması gerektiğini unutma. Birkaç kez yanlış yaparsan, örnek kodu yenileyip baştan başlaman iyi olabilir.
Bu egzersiz, kursun bir parçasıdır
Python'da Yazılım Mühendisliği İlkeleri
Egzersiz talimatları
- Sınıf tanımında kullanmak üzere
text_analyzerpaketindenDocumentsınıfınıimportet. - Docstring’in,
__init__metodunun parametreleriyle ilgili satırını tamamla. - Docstring’i,
SocialMediasınıfının öznitelikleri yani 'instance variables' için belgelemeyi doldurarak tamamla.
Uygulamalı etkileşimli egzersiz
Bu egzersizi bu örnek kodu tamamlayarak deneyin.
____
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()