summaryrefslogtreecommitdiff
path: root/lib/Travel
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2023-08-21 20:06:40 +0200
committerBirte Kristina Friesel <derf@finalrewind.org>2023-08-21 20:06:40 +0200
commit708c892d0583fc685b032a9a27642d1945346718 (patch)
tree353ce79096dffc04234ed7961d277d29c39d146a /lib/Travel
parentd57e93819d6c6d3adafe6271d87f7dd527971c7d (diff)
HAFAS: more detailed new_p rejection documentation
Diffstat (limited to 'lib/Travel')
-rw-r--r--lib/Travel/Status/DE/HAFAS.pm11
1 files changed, 6 insertions, 5 deletions
diff --git a/lib/Travel/Status/DE/HAFAS.pm b/lib/Travel/Status/DE/HAFAS.pm
index 41230ea..dcdd165 100644
--- a/lib/Travel/Status/DE/HAFAS.pm
+++ b/lib/Travel/Status/DE/HAFAS.pm
@@ -1016,11 +1016,12 @@ Request a polyline (series of geo-coordinates) indicating the train's route.
=item my $status_p = Travel::Status::DE::HAFAS->new_p(I<%opt>)
Return a promise that resolves into a Travel::Status::DE::HAFAS instance
-($status) on success and rejects with an error message and optional HAFAS
-instance ($status->errstr[, $status]) on failure. The optional HAFAS instance
-is only present if the error occured late, e.g. due to an ambiguous location
-specifier. In addition to the arguments of B<new>, the following mandatory
-arguments must be set.
+($status) on success and rejects with an error message on failure. If the
+failure occured after receiving a response from the HAFAS backend, the rejected
+promise contains a Travel::Status::DE::HAFAS instance as a second argument.
+This instance can be used e.g. to call similar_stops in case of an ambiguous
+location specifier. In addition to the arguments of B<new>, the following
+mandatory arguments must be set.
=over