From 639f8678effc8f604f345d9ec57c23d9487c630d Mon Sep 17 00:00:00 2001 From: Daniel Friesel Date: Sun, 26 Apr 2020 13:39:24 +0200 Subject: Minor documentation update --- bin/db-wagenreihung | 31 ++++++++++++++++++++++++++----- lib/Travel/Status/DE/DBWagenreihung.pm | 2 ++ 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/bin/db-wagenreihung b/bin/db-wagenreihung index e143ef8..e8d1c82 100755 --- a/bin/db-wagenreihung +++ b/bin/db-wagenreihung @@ -162,16 +162,37 @@ B I I version 0.02 +This is beta software: API and output format may change without notice. + =head1 DESCRIPTION -db-wagenreihung shows wagon orders as reported by the Deutsche Bahn Wagon Order -API. At the moment, only long-distance ICE trains operated by Deutsche -Bahn are supported. Most IC/EC lines also work, but results may not be -entirely correct. +db-wagenreihung shows the wagon order of train I at station +I (must be a name or DS100 code) as reported by the Deutsche Bahn +Wagon Order API. As of April 2020, long-distance IC/EC/ICFE trains are widely +supported, and some regions (e.g. Stuttgart/Karlsruhe) also provide wagon +orders for select regional trains. Data accuracy varies, but seems to be +improving over time. + +It is not possible to request the wagon order at a train's terminus station. +This is a known limitation. The departure of I must be in the time range between now and two hours in the future. +=head1 EXAMPLES + +=over + +=item db-wagenreihung 'Essen Hbf' 723 + +Show wagon order of ICE 723 at Essen Hbf + +=item db-wagenreihung TS 3259 + +Show wagon order of IRE 3259 at Stuttgart Hbf + +=back + =head1 DEPENDENCIES =over @@ -186,7 +207,7 @@ two hours in the future. =head1 AUTHOR -Copyright (C) 2018-2019 by Daniel Friesel Ederf@finalrewind.orgE +Copyright (C) 2018-2020 by Daniel Friesel Ederf@finalrewind.orgE =head1 LICENSE diff --git a/lib/Travel/Status/DE/DBWagenreihung.pm b/lib/Travel/Status/DE/DBWagenreihung.pm index 2289383..9935e10 100644 --- a/lib/Travel/Status/DE/DBWagenreihung.pm +++ b/lib/Travel/Status/DE/DBWagenreihung.pm @@ -480,6 +480,8 @@ Travel::Status::DE::DBWagenreihung - Interface to Deutsche Bahn Wagon Order API. version 0.02 +This is beta software. The API may change without notice. + =head1 DESCRIPTION Travel:Status:DE::DBWagenreihung is an unofficial interface to the Deutsche -- cgit v1.2.3