Add docstrings

aleksis/apps/chronos/model_extensions.py

@@ -88,6 +88,7 @@ def lesson_periods_as_teacher(self):
 
 
 def for_timetables(cls):
+    """Return all announcements that should be shown in timetable views."""
     return cls.objects.filter(show_in_timetables=True)
 
 

aleksis/apps/chronos/tables.py

@@ -13,6 +13,7 @@ from .models import LessonPeriod
 def _css_class_from_lesson_state(
     record: Optional[LessonPeriod] = None, table: Optional[LessonsTable] = None
 ) -> str:
+    """Return CSS class depending on lesson state."""
     if record.get_substitution(record._week):
         if record.get_substitution(record._week).cancelled:
             return "success"
@@ -23,6 +24,7 @@ def _css_class_from_lesson_state(
 
 
 class LessonsTable(tables.Table):
+    """Table for daily lessons and management of substitutions."""
     class Meta:
         attrs = {"class": "highlight"}
         row_attrs = {"class": _css_class_from_lesson_state}

aleksis/apps/chronos/util/format.py

+from datetime import date
+
+from aleksis.apps.chronos.models import TimePeriod
 from django.utils.formats import date_format
 
 
-def format_m2m(f, attr: str = "short_name"):
+def format_m2m(f, attr: str = "short_name") -> str:
+    """Join a attribute of all elements of a ManyToManyField."""
     return ", ".join([getattr(x, attr) for x in f.all()])
 
 
-def format_date_period(date, period):
-    return "{}, {}.".format(date_format(date), period.period)
+def format_date_period(day: date, period: TimePeriod) -> str:
+    """Format date and time period."""
+    return "{}, {}.".format(date_format(day), period.period)