1. Learn
    2. /
  2. Courses
    3. /
  3. Software Engineering Principles in Python

Exercise

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.

Instructions

100 XP
  • import the Document class from the text_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.