diff --git a/aleksis/apps/chronos/model_extensions.py b/aleksis/apps/chronos/model_extensions.py index 1607bd241868ee6c9c147ab22a90e1ed4a03647e..1a1bcd59a7f61a40b31d07f5982f6af3339c9fd5 100644 --- a/aleksis/apps/chronos/model_extensions.py +++ b/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) diff --git a/aleksis/apps/chronos/tables.py b/aleksis/apps/chronos/tables.py index ed224b4c5470f1b9098ce972595bcd4697aeaf73..9915dd47ae9fa510170f30481301f961bd41e6fe 100644 --- a/aleksis/apps/chronos/tables.py +++ b/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} diff --git a/aleksis/apps/chronos/util/format.py b/aleksis/apps/chronos/util/format.py index c85668bff93f274fdf27fc33ec0f07d064eaa901..49cf4c15705a5c761bb70f2fbab2289795f32bd6 100644 --- a/aleksis/apps/chronos/util/format.py +++ b/aleksis/apps/chronos/util/format.py @@ -1,9 +1,14 @@ +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)