From fc34915d1d53e444fa40f71d273c6ab0b131ba06 Mon Sep 17 00:00:00 2001
From: Jonathan Weth <git@jonathanweth.de>
Date: Wed, 24 Feb 2021 10:57:17 +0100
Subject: [PATCH] [Events/extra lessons] Improve variable naming and fix typos

---
 aleksis/apps/alsijil/model_extensions.py     | 14 +++++++-------
 aleksis/apps/alsijil/util/alsijil_helpers.py |  2 +-
 aleksis/apps/alsijil/views.py                |  1 +
 3 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/aleksis/apps/alsijil/model_extensions.py b/aleksis/apps/alsijil/model_extensions.py
index e72e347b3..862b4222e 100644
--- a/aleksis/apps/alsijil/model_extensions.py
+++ b/aleksis/apps/alsijil/model_extensions.py
@@ -215,7 +215,7 @@ def get_lesson_documentation(
         return None
 
 
-def get_lesson_documentation_simple(
+def get_lesson_documentation_single(
     self, week: Optional[CalendarWeek] = None
 ) -> Union[LessonDocumentation, None]:
     """Get lesson documentation object for this event/extra lesson."""
@@ -224,8 +224,8 @@ def get_lesson_documentation_simple(
     return None
 
 
-Event.method(get_lesson_documentation_simple, "get_lesson_documentation")
-ExtraLesson.method(get_lesson_documentation_simple, "get_lesson_documentation")
+Event.method(get_lesson_documentation_single, "get_lesson_documentation")
+ExtraLesson.method(get_lesson_documentation_single, "get_lesson_documentation")
 
 
 @LessonPeriod.method
@@ -235,13 +235,13 @@ def get_or_create_lesson_documentation(
     """Get or create lesson documentation object for this lesson."""
     if not week:
         week = self.week
-    lesson_documentation, created = LessonDocumentation.objects.get_or_create(
+    lesson_documentation, __ = LessonDocumentation.objects.get_or_create(
         lesson_period=self, week=week.week, year=week.year
     )
     return lesson_documentation
 
 
-def get_or_create_lesson_documentation_simple(
+def get_or_create_lesson_documentation_single(
     self, week: Optional[CalendarWeek] = None
 ) -> LessonDocumentation:
     """Get or create lesson documentation object for this event/extra lesson."""
@@ -249,8 +249,8 @@ def get_or_create_lesson_documentation_simple(
     return lesson_documentation
 
 
-Event.method(get_or_create_lesson_documentation_simple, "get_or_create_lesson_documentation")
-ExtraLesson.method(get_or_create_lesson_documentation_simple, "get_or_create_lesson_documentation")
+Event.method(get_or_create_lesson_documentation_single, "get_or_create_lesson_documentation")
+ExtraLesson.method(get_or_create_lesson_documentation_single, "get_or_create_lesson_documentation")
 
 
 @LessonPeriod.method
diff --git a/aleksis/apps/alsijil/util/alsijil_helpers.py b/aleksis/apps/alsijil/util/alsijil_helpers.py
index 31c97fbbe..f44a90944 100644
--- a/aleksis/apps/alsijil/util/alsijil_helpers.py
+++ b/aleksis/apps/alsijil/util/alsijil_helpers.py
@@ -58,7 +58,7 @@ def get_timetable_instance_by_pk(
 def annotate_documentations(
     klass: Union[Event, LessonPeriod, ExtraLesson], wanted_week: CalendarWeek, pks: List[int]
 ) -> QuerySet:
-    """Return a annotated queryset of all provided register objects."""
+    """Return an annotated queryset of all provided register objects."""
     if isinstance(klass, LessonPeriod):
         prefetch = Prefetch(
             "documentations",
diff --git a/aleksis/apps/alsijil/views.py b/aleksis/apps/alsijil/views.py
index 53ca6aaa1..5c7e9a8e9 100644
--- a/aleksis/apps/alsijil/views.py
+++ b/aleksis/apps/alsijil/views.py
@@ -562,6 +562,7 @@ def full_register_group(request: HttpRequest, id_: int) -> HttpResponse:
     documentations = (
         LessonDocumentation.objects.select_related("lesson_period").not_empty().filter(groups_q)
     )
+
     # Get all lesson periods for the selected group
     lesson_periods = LessonPeriod.objects.filter_group(group).distinct()
     events = Event.objects.filter_group(group).distinct()
-- 
GitLab