profitroll/PythonRMV
profitroll/PythonRMV
1
1
Fork 0
Code Issues Pull Requests Actions Packages Releases 3 Wiki Activity

Fixed small docstring issues

Browse Source
This commit is contained in:
Profitroll 2022-10-06 14:34:54 +02:00
parent 5613bf7e3f
commit 0d9ea775a6
7 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pyrmv/methods/board_arrival.py
View File

@ -45,7 +45,7 @@ def board_arrival(
* board_type (`Union[BoardArrivalType.ARR, BoardArrivalType.ARR_EQUIVS, BoardArrivalType.ARR_MAST, BoardArrivalType.ARR_STATION]`, optional): Set the station arrival board type to be used. Defaults to `BoardArrivalType.ARR`. * board_type (`Union[BoardArrivalType.ARR, BoardArrivalType.ARR_EQUIVS, BoardArrivalType.ARR_MAST, BoardArrivalType.ARR_STATION]`, optional): Set the station arrival board type to be used. Defaults to `BoardArrivalType.ARR`.
### Returns: ### Returns:
* BoardArrival: Instance of BoardArrival object. * BoardArrival: Instance of `BoardArrival` object.
""" """
if (isinstance(direction, Stop) or isinstance(direction, StopTrip)): if (isinstance(direction, Stop) or isinstance(direction, StopTrip)):

2
pyrmv/methods/board_departure.py
View File

@ -45,7 +45,7 @@ def board_departure(
* board_type (`Union[BoardDepartureType.DEP, BoardDepartureType.DEP_EQUIVS, BoardDepartureType.DEP_MAST, BoardDepartureType.DEP_STATION]`, optional): Set the station departure board type to be used. Defaults to `BoardDepartureType.DEP`. * board_type (`Union[BoardDepartureType.DEP, BoardDepartureType.DEP_EQUIVS, BoardDepartureType.DEP_MAST, BoardDepartureType.DEP_STATION]`, optional): Set the station departure board type to be used. Defaults to `BoardDepartureType.DEP`.
### Returns: ### Returns:
* BoardDeparture: Instance of BoardDeparture object. * BoardDeparture: Instance of `BoardDeparture` object.
""" """
if (isinstance(direction, Stop) or isinstance(direction, StopTrip)): if (isinstance(direction, Stop) or isinstance(direction, StopTrip)):

2
pyrmv/methods/journey_detail.py
View File

@ -39,7 +39,7 @@ def journey_detail(
* to_index (`int`, **optional**): Specifies the station/stop index the partial itinerary shall end at. Defaults to `None`. * to_index (`int`, **optional**): Specifies the station/stop index the partial itinerary shall end at. Defaults to `None`.
### Returns: ### Returns:
* Journey: Instance of Journey object. * Journey: Instance of `Journey` object.
""" """
if real_time_mode == None: if real_time_mode == None:

2
pyrmv/methods/stop_by_coords.py
View File

@ -39,7 +39,7 @@ def stop_by_coords(
* selection_mode (`Literal[SelectionMode.SLCT_A, SelectionMode.SLCT_N]`, **optional**): Selection mode for locations. `SelectionMode.SLCT_N`: Not selectable, `SelectionMode.SLCT_A`: Selectable. Defaults to `None`. * selection_mode (`Literal[SelectionMode.SLCT_A, SelectionMode.SLCT_N]`, **optional**): Selection mode for locations. `SelectionMode.SLCT_N`: Not selectable, `SelectionMode.SLCT_A`: Selectable. Defaults to `None`.
### Returns: ### Returns:
* List[Stop]: List of Stop objects. Empty list if none found. * List[Stop]: List of `Stop` objects. Empty list if none found.
""" """
if selection_mode == None: if selection_mode == None:

2
pyrmv/methods/stop_by_id.py
View File

@ -23,7 +23,7 @@ def stop_by_id(
* lang (`Literal[Language.DE, Language.DA, Language.EN, Language.ES, Language.FR, Language.HU, Language.IT, Language.NL, Language.NO, Language.PL, Language.SV, Language.TR]`, **optional**): The language of response. Defaults to `Language.EN`. * lang (`Literal[Language.DE, Language.DA, Language.EN, Language.ES, Language.FR, Language.HU, Language.IT, Language.NL, Language.NO, Language.PL, Language.SV, Language.TR]`, **optional**): The language of response. Defaults to `Language.EN`.
### Returns: ### Returns:
* Stop: Instance of Stop object or None if not found. * Stop: Instance of `Stop` object or `None` if not found.
""" """
stops_raw = raw_stop_by_name( stops_raw = raw_stop_by_name(

2
pyrmv/methods/stop_by_name.py
View File

@ -49,7 +49,7 @@ def stop_by_name(
* filter_mode (`Literal[FilterMode.DIST_PERI, FilterMode.EXCL_PERI, FilterMode.SLCT_PERI]`, **optional**): Filter modes for nearby searches. Defaults to `FilterMode.DIST_PERI`. * filter_mode (`Literal[FilterMode.DIST_PERI, FilterMode.EXCL_PERI, FilterMode.SLCT_PERI]`, **optional**): Filter modes for nearby searches. Defaults to `FilterMode.DIST_PERI`.
### Returns: ### Returns:
* List[Stop]: List of Stop objects. Empty list if none found. * List[Stop]: List of `Stop` objects. Empty list if none found.
""" """
if selection_mode == None: if selection_mode == None:

2
pyrmv/methods/trip_find.py
View File

@ -125,7 +125,7 @@ def trip_find(
* frequency (`bool`, **optional**): Enables/disables the calculation of frequency information. Defaults to `True`. * frequency (`bool`, **optional**): Enables/disables the calculation of frequency information. Defaults to `True`.
### Returns: ### Returns:
* List[Trip]: List of Trip objects. Empty list if none found. * List[Trip]: List of `Trip` objects. Empty list if none found.
""" """
if real_time_mode == None: if real_time_mode == None: