From 8ad6d5164c0999deca742abbe25c386ea90780c0 Mon Sep 17 00:00:00 2001
From: Sarah Vaupel <sarah.vaupel@ifi.lmu.de>
Date: Thu, 6 May 2021 14:57:06 +0200
Subject: [PATCH] refactor(schedule): rename auxiliray def, more doc

---
 src/Utils/Schedule/Week.hs | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/Utils/Schedule/Week.hs b/src/Utils/Schedule/Week.hs
index 6867b6bf0..bd0942796 100644
--- a/src/Utils/Schedule/Week.hs
+++ b/src/Utils/Schedule/Week.hs
@@ -160,7 +160,7 @@ weekSchedule now user@(Entity uid User{userScheduleWeekDays = ScheduleWeekDays u
             ScheduleCourseEvent{..} -> goPrune sceNoOccur sceTerm sceOccurrence
             ScheduleTutorial{..}    -> goPrune stNoOccur  stTerm  stOccurrence
             _ -> True
-      in sortOn (views _1 $ scheduleEntryToStart currentDay) $ filter (views _1 isRegularWithoutException) occurrencesInSlot
+      in sortOn (views _1 $ scheduleEntryStartUTC currentDay) $ filter (views _1 isRegularWithoutException) occurrencesInSlot
 
     -- TODO: perform this filtering asap, in DB fetch if possible
     events :: Map Day (Map TimeSlot [(ScheduleEntry, SlotAssociation)])
@@ -224,8 +224,9 @@ scheduleEntryToHref = \case
   ScheduleTutorial{stCourse=(Entity _ Course{..})} -> CourseR courseTerm courseSchool courseShorthand CShowR  -- TODO: link to table with id "tutorials"?
   ScheduleExamOccurrence{seoCourse=(Entity _ Course{..}),seoExamName} -> CExamR courseTerm courseSchool courseShorthand seoExamName EShowR
 
-scheduleEntryToStart :: Day -> ScheduleEntry -> UTCTime
-scheduleEntryToStart currentDay = \case
+-- | At which UTCTime does a ScheduleEntry start, given a specific day?
+scheduleEntryStartUTC :: Day -> ScheduleEntry -> UTCTime
+scheduleEntryStartUTC currentDay = \case
   ScheduleCourseEvent{sceOccurrence} -> occurrenceToStart sceOccurrence
   ScheduleTutorial{stOccurrence}     -> occurrenceToStart stOccurrence
   ScheduleExamOccurrence{seoStart}   -> seoStart