From e2eda73b852a8091bbb150b99ee13a338872d804 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Sat, 19 Oct 2019 10:56:03 +0200
Subject: Document $status->related_stations

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

(limited to 'lib/Travel/Status/DE')

diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm
index ddc53f6..a6111a4 100644
--- a/lib/Travel/Status/DE/IRIS.pm
+++ b/lib/Travel/Status/DE/IRIS.pm
@@ -718,6 +718,17 @@ departures for all related stations.
 In case of a fatal HTTP request or IRIS error, returns a string describing it.
 Returns undef otherwise.
 
+=item $status->related_stations
+
+Returns a list of hashes describing related stations whose
+arrivals/departures are included in B<results>. Only useful when setting
+B<with_related> to a true value, see its documentation above for details.
+
+Each hash contains the keys B<uic> (UIC/EVA number; known as IBNR in Germany),
+B<name> (station name), and B<ds100> (station code). Note that stations
+returned by B<related_stations> are not necessarily known to
+Travel::Status::DE::IRIS::Stations(3pm).
+
 =item $status->results
 
 Returns a list of Travel::Status::DE::IRIS::Result(3pm) objects, each one describing
-- 
cgit v1.2.3