1. Nauka
  2. /
  3. Kursy
  4. /
  5. Zasady inżynierii oprogramowania w Pythonie

Connected

ćwiczenie

Dokumentowanie klas dla Sphinx

sphinx to świetne narzędzie do renderowania dokumentacji w postaci HTML. W tym ćwiczeniu napiszesz docstring dla klasy, który będzie w pełni wykorzystywany przez sphinx.

Zwróć uwagę, że twój docstring musi być dokładnie zgodny z rozwiązaniem. Jeśli kilka razy nie uda ci się uzyskać poprawnego wyniku, warto zresetować przykładowy kod i zacząć od początku.

Instrukcje

100 XP
  • Za pomocą import zaimportuj klasę Document from pakietu text_analyzer, aby użyć jej w definicji klasy.
  • Uzupełnij linię docstringa dotyczącą parametrów metody __init__.
  • Dokończ docstring, wypełniając dokumentację atrybutów, czyli „zmiennych instancji" klasy SocialMedia.