From cc9dd0a40d8a1f048426a5cad22c67f882ed8724 Mon Sep 17 00:00:00 2001
From: Daniel Friesel <derf@finalrewind.org>
Date: Thu, 25 Mar 2021 22:01:00 +0100
Subject: Result: document occupancy accessor

---
 lib/Travel/Status/DE/EFA/Result.pm | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'lib/Travel/Status')

diff --git a/lib/Travel/Status/DE/EFA/Result.pm b/lib/Travel/Status/DE/EFA/Result.pm
index 20241f7..4a4736a 100644
--- a/lib/Travel/Status/DE/EFA/Result.pm
+++ b/lib/Travel/Status/DE/EFA/Result.pm
@@ -208,6 +208,14 @@ and 11.
 Returns the "mode of transport", for instance "zug", "s-bahn", "tram" or
 "sonstige".
 
+=item $departure->occupancy
+
+Returns expected occupancy, if available, undef otherwise.
+
+Occupancy values are passed from the backend as-is. Known values are
+"MANY_SEATS" (low occupation), "FEW_SEATS" (high occupation), and
+"STANDING_ONLY" (very high occupation).
+
 =item $departure->platform
 
 Departure platform number (may not be a number).
-- 
cgit v1.2.3