Skip to content
Snippets Groups Projects
Commit 5593af87 authored by David Trattnig's avatar David Trattnig
Browse files

docs: extend docstrings

parent fcd23698
No related branches found
No related tags found
1 merge request!35ORM-less scheduling
......@@ -82,6 +82,9 @@ class TimetableService:
1. Fetch the latest timeslots from the API or the API cache.
2. Merge with the current timetable.
3. Persist to `timetable.json`
Args:
fetcher (ApiFetcher): Service to fetch timeslots and playlists.
"""
self.logger.debug("Trying to fetch new timeslots from API endpoints...")
# Create a fetching thread and wait until it is done
......@@ -297,6 +300,10 @@ class TimetableMerger:
The start time of any timeslot acts as the key. The map value holds a dictionary, where
the `local` key is the local timeslot, and the `remote` key holds the remote timeslot.
Args:
local_timeslots ([Timeslot]): The current timetable.
remote_timeslots ([Timeslot]): The latest timeslots from the API.
Returns:
({str: {}}): Map with timestamp as key and a dictionary referencing timeslots.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment