Enums docstring improved

This commit is contained in:
Profitroll 2022-10-05 12:16:25 +02:00
parent 70aa206cba
commit b069b82cc5
3 changed files with 27 additions and 3 deletions

View File

@ -2,7 +2,12 @@ from enum import auto
from .auto_name import AutoName
class FilterMode(AutoName):
"""Enumeration used to declare filters for nearby searches."""
"""Enumeration used to declare filters for nearby searches.
* DIST_PERI - Accentuate matches. Matches in the radius are first
* EXCL_PERI - Returns matches inside the radius only
* SLCT_PERI - Matches in the radius are excluded. Returns matches outside the radius only
"""
DIST_PERI = auto()
"Accentuate matches. Matches in the radius are first."

View File

@ -2,7 +2,22 @@ from enum import auto
from .auto_name import AutoName
class LocationType(AutoName):
"""Enumeration used to declare types of location filter."""
"""Enumeration used to declare types of location filter.
* S - Search for station/stops only
* A - Search for addresses only
* P - Search for POIs only
* AP - Search for addresses and POIs
* SA - Search for station/stops and addresses
* SE - Search for stations/stops and entrypoints
* SP - Search for stations/stops and POIs
* ALL - Search in all existing location pools
* SPE - Search for stations/stops, POIs and entrypoints
Note that not all location types may be available for a certain methods.
Make sure that selected type is supported by method by looking up
its acceptable types in argument description.
"""
S = auto()
"Search for station/stops only"

View File

@ -2,7 +2,11 @@ from enum import auto
from .auto_name import AutoName
class SelectionMode(AutoName):
"""Enumeration used to declare location selection modes."""
"""Enumeration used to declare location selection modes.
* SLCT_A - Selectable
* SLCT_N - Not selectable
"""
SLCT_A = auto()
"Selectable"