Added note to get_schedule

dnorhoj · Sep 28, 2022 · 91c2a69 · 91c2a69
1 parent e5874bf
commit 91c2a69
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lectio/models/user.py b/lectio/models/user.py
@@ -119,6 +119,11 @@ def __populate(self) -> None:
     def get_schedule(self, start_date: 'datetime', end_date: 'datetime', strip_time: bool = True) -> List['Module']:
         """Get schedule for user
 
+        Note:
+            As lectio is weird, you can only get a schedule for a range
+            that is less than one month.
+            If you specify a range greater than one month, you will get an empty return list.
+
         Args:
             start_date (:class:`datetime.datetime`): Start date
             end_date (:class:`datetime.datetime`): End date