From d464e7ba8cec21c9e0ec7b418cf7414fa7942c97 Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 5 Feb 2017 10:47:57 +0100 Subject: documentation --- lib/Travel/Status/DE/IRIS.pm | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) (limited to 'lib/Travel/Status') diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm index 9965bc9..fbf449e 100644 --- a/lib/Travel/Status/DE/IRIS.pm +++ b/lib/Travel/Status/DE/IRIS.pm @@ -588,15 +588,28 @@ IRIS base url, defaults to C<< http://iris.noncd.db.de/iris-tts/timetable >>. =item B => I -Compute only those results which are less than I minutes in the future. -Default: 240 (4 hours). - -Note that the DeutscheBahn IRIS backend only provides schedules up to four -to five hours into the future, and this module only requests data for up to -three hours. So in most cases, setting this to a value above 180 minutes will -have no effect. However, as the IRIS occasionally contains unscheduled -departures or qos messages known far in advance (e.g. 12 hours from now), any -non-negative integer is accepted. +Compute only results which are less than I minutes in the future. +Default: 180 (3 hours). + +Note that the DeutscheBahn IRIS backend only provides schedules up to four to +five hours into the future. So in most cases, setting this to a value above 240 +minutes will have little effect. However, as the IRIS occasionally contains +unscheduled departures or qos messages known far in advance (e.g. 12 hours from +now), any non-negative integer is accepted. + +=item B => I + +Also check trains whose scheduled departure lies up to I minutes in the +past. Default: 0. + +This is useful when requesting departures shortly after a full hour. If, +for example, a train was scheduled to depart on 11:59 and has 5 minutes delay, +it will not be shown when requesting departures on or after 12:00 unless +B is set to a value greater than zero. + +Note that trains with significant delay (e.g. +30) may still be shown in this +case regardless of the setting of B, since these receive special +treatment by the IRIS backend. =item B => I<\%hashref> -- cgit v1.2.3