Documenting classes for Sphinx
sphinx
is a great tool for rendering documentation as HTML. In this exercise, you'll write a docstring for a class that can be taken advantage of by sphinx
.
Note that your docstring submission must match the solution exactly. If you find yourself getting it wrong several times, it may be a good idea to refresh the sample code and start over.
This exercise is part of the course
Software Engineering Principles in Python
Exercise instructions
import
theDocument
classfrom
thetext_analyzer
package for use in the class definition.- Complete the line of the docstring dealing with the parameters of the
__init__
method. - Complete the docstring by filling out the documentation for the attributes or 'instance variables' of the
SocialMedia
class.
Hands-on interactive exercise
Have a go at this exercise by completing this sample code.
____
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()