summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2024-04-02 19:34:22 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2024-04-02 19:34:22 +0200
commitdf17fc508bec7626c456eb41284e64da8785ef1a (patch)
tree148b01a0c19a8e11e20f900f1010028bf0a9b3a5
parentaba8e771a7be92ea9b91d74fd3bf08f02c283e25 (diff)
Journey(3pm), Stop(3pm): Document time zone handling
-rw-r--r--lib/Travel/Status/DE/HAFAS/Journey.pm12
-rw-r--r--lib/Travel/Status/DE/HAFAS/Stop.pm12
2 files changed, 15 insertions, 9 deletions
diff --git a/lib/Travel/Status/DE/HAFAS/Journey.pm b/lib/Travel/Status/DE/HAFAS/Journey.pm
index f8b0f3f..90708dc 100644
--- a/lib/Travel/Status/DE/HAFAS/Journey.pm
+++ b/lib/Travel/Status/DE/HAFAS/Journey.pm
@@ -411,7 +411,9 @@ a station-specific arrival/departure obtained by a stationboard query, or a
train journey that does not belong to a specific station.
stationboard-specific accessors are annotated with "(station only)" and return
-undef for non-station journeys.
+undef for non-station journeys. All date and time entries refer to the
+backend time zone (Europe/Berlin in most cases) and do not take local time
+into account; see B<tz_offset> for the latter.
=head1 METHODS
@@ -481,10 +483,10 @@ undef if neither is available.
=item $journey->tz_offset
-Offset between the backend's time zone (default: Europe/Berlin) and this
-journey's time zone in minutes, if any. For instance, if the backend is
-currently in UTC+2 (CEST) and the journey is in UTC+1 (IST), tz_offset is -60.
-undef if both are in the same time zone (or rather, the same UTC offset).
+Offset between backend time zone (default: Europe/Berlin) and this journey's
+time zone in minutes, if any. For instance, if the backend uses UTC+2 (CEST)
+and the journey uses UTC+1 (IST), tz_offset is -60. Returns undef if both use
+the same time zone (or rather, the same UTC offset).
=item $journey->delay (station only)
diff --git a/lib/Travel/Status/DE/HAFAS/Stop.pm b/lib/Travel/Status/DE/HAFAS/Stop.pm
index 0a1f44f..0b4a2f3 100644
--- a/lib/Travel/Status/DE/HAFAS/Stop.pm
+++ b/lib/Travel/Status/DE/HAFAS/Stop.pm
@@ -227,6 +227,10 @@ Travel::Status::DE::HAFAS::Journey(3pm)'s stop at a given
Travel::Status::DE::HAFAS::Location(3pm) with arrival/departure time,
platform, etc.
+All date and time entries refer to the backend time zone (Europe/Berlin in most
+cases) and do not take local time into account; see B<tz_offset> for the
+latter.
+
=head1 METHODS
=head2 ACCESSORS
@@ -280,10 +284,10 @@ Departure is cancelled.
=item $stop->tz_offset
-Offset between the backend's time zone (default: Europe/Berlin) and this stop's
-time zone in minutes, if any. For instance, if the backend is currently in UTC+2
-(CEST) and the stop is in UTC+1 (IST), tz_offset is -60. undef if both are in
-the same time zone (or rather, the same UTC offset).
+Offset between backend time zone (default: Europe/Berlin) and this stop's time
+zone in minutes, if any. For instance, if the backend uses UTC+2 (CEST) and the
+stop uses UTC+1 (IST), tz_offset is -60. Returns undef if both use the same
+time zone (or rather, the same UTC offset).
=item $stop->delay