summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2013-12-24 17:04:49 +0100
committerDaniel Friesel <derf@finalrewind.org>2013-12-24 17:04:49 +0100
commitd37d400761ef47cac90dfa1c87ed067e32ee6b64 (patch)
tree4ca28f320ac972b0cd25772ef6a324b8c77a1631
parent686a48d6bdfa7ccb20e536a9151ce3c146a1e236 (diff)
add get_stop_by_name to documentation
-rw-r--r--Changelog2
-rw-r--r--lib/Travel/Status/DE/URA.pm7
2 files changed, 8 insertions, 1 deletions
diff --git a/Changelog b/Changelog
index 9471a62..971919f 100644
--- a/Changelog
+++ b/Changelog
@@ -1,7 +1,7 @@
git HEAD
* Remove fuzzy matching from constructor / ->results API. Use
- the new get_stop_by_name function instead (returns all matching stop).
+ the new get_stop_by_name function instead (returns all matching stops).
Update aseag-m accordingly
Travel::Status::DE::URA 0.01 - Sun Dec 22 2013
diff --git a/lib/Travel/Status/DE/URA.pm b/lib/Travel/Status/DE/URA.pm
index 99c0132..dd199a6 100644
--- a/lib/Travel/Status/DE/URA.pm
+++ b/lib/Travel/Status/DE/URA.pm
@@ -301,6 +301,13 @@ the server.
In case of an HTTP request error, returns a string describing it. If none
occured, returns undef.
+=item $status->get_stop_by_name(I<$stopname>)
+
+Returns a list of stops matching I<$stopname>. For instance, if the stops
+"Aachen Bushof", "Eupen Bushof", "Brand" and "Brandweiher" exist, the
+parameter "bushof" will return "Aachen Bushof" and "Eupen Bushof", while
+"brand" will only return "Brand".
+
=item $status->results(I<%opt>)
Returns a list of Travel::Status::DE::URA::Result(3pm) objects, each describing