From 6e5b350cb7514eb94bb79d922844e9743b94e2e5 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Sat, 26 Dec 2015 19:41:46 +0100
Subject: IRIS.pm: Document with_related option

---
 lib/Travel/Status/DE/IRIS.pm | 11 +++++++++++
 1 file changed, 11 insertions(+)

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
-- 
cgit v1.2.3