From 723361a3866b23a92616dc5d6c2f7c82d4cb3d1d Mon Sep 17 00:00:00 2001
From: Jonathan Weth <git@jonathanweth.de>
Date: Wed, 24 Feb 2021 11:21:01 +0100
Subject: [PATCH] Add some explanatory comments
---
aleksis/apps/alsijil/model_extensions.py | 3 +++
aleksis/apps/alsijil/util/alsijil_helpers.py | 5 ++++-
2 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/aleksis/apps/alsijil/model_extensions.py b/aleksis/apps/alsijil/model_extensions.py
index 67823949a..d7ebda3a4 100644
--- a/aleksis/apps/alsijil/model_extensions.py
+++ b/aleksis/apps/alsijil/model_extensions.py
@@ -385,6 +385,9 @@ def generate_person_list_with_class_register_statistics(
"""Get with class register statistics annotated list of all members."""
if persons is None:
persons = self.members.all()
+
+ # Build reusable Q objects for filtering by school term and by groups
+ # Necessary for the following annotations
school_term_q = (
Q(personal_notes__lesson_period__lesson__validity__school_term=self.school_term)
| Q(personal_notes__extra_lesson__school_term=self.school_term)
diff --git a/aleksis/apps/alsijil/util/alsijil_helpers.py b/aleksis/apps/alsijil/util/alsijil_helpers.py
index 0ea834bad..9aedcb24e 100644
--- a/aleksis/apps/alsijil/util/alsijil_helpers.py
+++ b/aleksis/apps/alsijil/util/alsijil_helpers.py
@@ -89,7 +89,10 @@ def annotate_documentations(
def register_objects_sorter(register_object: Union[LessonPeriod, Event, ExtraLesson]) -> int:
- """Sort key for sorted/sort for sorting a list of class register objects."""
+ """Sort key for sorted/sort for sorting a list of class register objects.
+
+ This will sort the objects by the start period.
+ """
if hasattr(register_object, "period"):
return register_object.period.period
elif isinstance(register_object, Event):
--
GitLab