summaryrefslogtreecommitdiff
path: root/lib/Travel
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2015-12-26 19:41:46 +0100
committerDaniel Friesel <derf@finalrewind.org>2015-12-26 19:41:46 +0100
commit6e5b350cb7514eb94bb79d922844e9743b94e2e5 (patch)
treee142e7820e5540a2ff2841cd49978573c741c046 /lib/Travel
parent15d0edfee77358006259759cec6a32e33f66ac3e (diff)
IRIS.pm: Document with_related option
Diffstat (limited to 'lib/Travel')
-rw-r--r--lib/Travel/Status/DE/IRIS.pm11
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm
index e299015..937bb65 100644
--- a/lib/Travel/Status/DE/IRIS.pm
+++ b/lib/Travel/Status/DE/IRIS.pm
@@ -574,6 +574,17 @@ station name, but a station code, such as "EE" (for Essen Hbf) or "KA"
(for Aachen Hbf). See Travel::Status::DE::IRIS::Stations(3pm) for a
name to code mapping.
+=item B<with_related> => I<bool>
+
+Sometimes, Deutsche Bahn splits up major stations in the IRIS interface. For
+instance, "KE<ouml>ln Messe/Deutz" actually consists of "KE<ouml>ln
+Messe/Deutz" (KKDZ), "KE<ouml>ln Messe/Deutz Gl. 9-10" (KKDZB) and "KE<ouml>ln
+Messe/Deutz (tief)" (KKDT).
+
+By default, Travel::Status::DE::IRIS only returns departures for the specified
+station. When this option is set to a true value, it will also return
+departures for all related stations.
+
=back
=item $status->errstr