Commit e8507620 authored by Birte Kristina Friesel's avatar Birte Kristina Friesel
Browse files

db-iris, Result.pm: Document additional_stops and canceled_stops

parent 9dede9a8
Loading
Loading
Loading
Loading
+10 −0
Original line number Diff line number Diff line
@@ -436,6 +436,16 @@ Valid output types are:

=over

=item a / additional

If a train's route deviates from its schedule: Print a list of additional
(unscheduled) stops it will stop at.

=item c / canceled

If a train's route deviates from its schedule: Print a list of canceled
stops (scheduled stops which will not be served).

=item d / delay

If a train is delayed, show the most recent reason for this delay.
+12 −0
Original line number Diff line number Diff line
@@ -593,11 +593,23 @@ the platform, time, route and more.

=over

=item $result->additional_stops

Returns served stops which are not part of the schedule. I.e., this is the
set of actual stops (B<route_post>) minus the set of scheduled stops
(B<sched_route_post>).

=item $result->arrival

DateTime(3pm) object for the arrival date and time. undef if the
train starts here. Contains realtime data if available.

=item $result->canceled_stops

Returns stops which are scheduled, but will not be served by this train.
I.e., this is the set of scheduled stops (B<sched_route_post>) minus the set of
actual stops (B<route_post>).

=item $result->classes

List of characters indicating the class(es) of this train, may be empty. This