Small docstring changes

This commit is contained in:
Profitroll 2022-10-05 13:50:44 +02:00
parent 65349e14b2
commit 93240ffcca
3 changed files with 4 additions and 4 deletions

View File

@ -26,7 +26,7 @@ def stop_by_coords(
"""Method returns a list of stops around a given center coordinate. """Method returns a list of stops around a given center coordinate.
The returned results are ordered by their distance to the center coordinate. The returned results are ordered by their distance to the center coordinate.
More detailed request is available as raw.stop_by_coords(), however returns dict instead of List[Stop]. More detailed request is available as `raw.stop_by_coords()`, however returns `dict` instead of `List[Stop]`.
### Args: ### Args:
* access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html). * access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html).

View File

@ -32,7 +32,7 @@ def stop_by_name(
of possible matches in the journey planner database. Possible matches might be stops/stations, of possible matches in the journey planner database. Possible matches might be stops/stations,
points of interest and addresses. points of interest and addresses.
More detailed request is available as raw.stop_by_name(), however returns dict instead of List[Stop]. More detailed request is available as `raw.stop_by_name()`, however returns `dict` instead of `List[Stop]`.
### Args: ### Args:
* access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html). * access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html).

View File

@ -77,7 +77,7 @@ def trip_find(
stop/station IDs or coordinates based on addresses and points of interest validated by the location service or stop/station IDs or coordinates based on addresses and points of interest validated by the location service or
coordinates freely defined by the client. coordinates freely defined by the client.
More detailed request is available as raw.trip_find(), however returns dict instead of List[Trip]. More detailed request is available as `raw.trip_find()`, however returns `dict` instead of `List[Trip]`.
### Args: ### Args:
* access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html). * access_id (`str`): Access ID for identifying the requesting client. Get your key on [RMV website](https://opendata.rmv.de/site/start.html).
@ -131,7 +131,7 @@ def trip_find(
if real_time_mode == None: if real_time_mode == None:
real_time_mode = None real_time_mode = None
else: else:
real_time_mode = (real_time_mode.code).upper() real_time_mode = real_time_mode.code
trips = [] trips = []
trips_raw = raw_trip_find( trips_raw = raw_trip_find(