summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2015-10-07 20:17:06 +0200
committerDaniel Friesel <derf@finalrewind.org>2015-10-07 20:17:06 +0200
commitd688b22c7630a4d590c2185732f9a910e30d4a6f (patch)
tree650eab869f0b8f7d8f00895e61ac2bf29959a155
parente0845072109fce647b5b61076f8bba978d3adf65 (diff)
URA.pm documentation
-rw-r--r--lib/Travel/Status/DE/URA.pm13
1 files changed, 5 insertions, 8 deletions
diff --git a/lib/Travel/Status/DE/URA.pm b/lib/Travel/Status/DE/URA.pm
index 00b2a40..f86d05c 100644
--- a/lib/Travel/Status/DE/URA.pm
+++ b/lib/Travel/Status/DE/URA.pm
@@ -292,7 +292,7 @@ The version, may be any string.
=back
The request URL is I<ura_base>/instant_VI<version>, so for
-C<< http://ivu.aseag.de/interfaces/ura >>, C<< 1 >> this module will point
+C<< http://ivu.aseag.de/interfaces/ura >>, C<< 1 >> this module will send
requests to C<< http://ivu.aseag.de/interfaces/ura/instant_V1 >>.
The following parameter is optional:
@@ -332,14 +332,11 @@ Accepted parameters (all are optional):
=over
-=item B<full_routes> => B<before>|B<after>|I<bool> (default 0)
+=item B<calculate_routes> => I<bool> (default 0)
-When set to a true value: Compute B<route_timetable> fields in all
-Travel::Status::DE::URA::Result(3pm) objects, otherwise they will not be
-set.
-
-B<before> / B<after> limits the timetable to stops before / after the stop
-I<name> (if set).
+When set to a true value: Compute routes for all results, enabling use of
+their B<route_> accessors. Otherwise, those will just return nothing
+(undef / empty list, depending on context).
=item B<hide_past> => I<bool> (default 1)