Document timetable terminology

This commit is contained in:
Hornwitser 2025-02-27 15:01:30 +01:00
parent 8296f9c17d
commit e5aac858e4
2 changed files with 7 additions and 1 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.1 KiB

View file

@ -5,6 +5,8 @@ const oneDayMs = 24 * 60 * 60 * 1000;
const oneHourMs = 60 * 60 * 1000;
const oneMinMs = 60 * 1000;
// See timetable-terminology.png for an illustration of how these terms are related
/** Point in time where a time slots starts or ends. */
type Edge = { type: "start" | "end", slot: TimeSlot };
@ -18,7 +20,11 @@ type Span = {
locations: Map<string, Set<TimeSlot>>,
};
/** Collection of adjacent spans containing TimeSlots that are close to each other in time */
/**
Collection of adjacent spans containing TimeSlots that are close to each
other in time. The start and end of the stretch is aligned to a whole hour
and the endpoint spans are always empty and at least one hour.
*/
type Stretch = {
start: string,
end: string,