Sphinx के लिए क्लासेज़ का डॉक्युमेंटेशन
sphinx एक बेहतरीन टूल है जो डॉक्युमेंटेशन को HTML के रूप में रेंडर करता है. इस अभ्यास में, आप एक ऐसी क्लास के लिए docstring लिखेंगे जिसका उपयोग sphinx द्वारा किया जा सके.
ध्यान दें कि आपकी docstring सबमिशन समाधान से बिल्कुल मेल खानी चाहिए. यदि आप कई बार गलती कर रहें हैं, तो नमूना कोड को रीफ्रेश करना और फिर से शुरू करना अच्छा विचार हो सकता है.
यह अभ्यास पाठ्यक्रम का हिस्सा है
Python में Software Engineering Principles
अभ्यास निर्देश
- क्लास परिभाषा में उपयोग के लिए
text_analyzerपैकेजfromDocumentक्लास कोimportकरें. - docstring की वह पंक्ति पूरी करें जो
__init__मेथड के पैरामीटर्स से संबंधित है. - docstring को पूरा करें और
SocialMediaक्लास की विशेषताओं या 'instance variables' का डॉक्युमेंटेशन भरें.
इंटरैक्टिव व्यावहारिक अभ्यास
इस अभ्यास को इस नमूना कोड को पूरा करके आज़माएँ।
____
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()