From b069b82cc52443b13b5aba53799a18c4649efad4 Mon Sep 17 00:00:00 2001 From: profitroll Date: Wed, 5 Oct 2022 12:16:25 +0200 Subject: [PATCH] Enums docstring improved --- pyrmv/enums/filter_mode.py | 7 ++++++- pyrmv/enums/location_type.py | 17 ++++++++++++++++- pyrmv/enums/selection_mode.py | 6 +++++- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/pyrmv/enums/filter_mode.py b/pyrmv/enums/filter_mode.py index 69414fc..192c3c0 100644 --- a/pyrmv/enums/filter_mode.py +++ b/pyrmv/enums/filter_mode.py @@ -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." diff --git a/pyrmv/enums/location_type.py b/pyrmv/enums/location_type.py index 4208b4b..9631444 100644 --- a/pyrmv/enums/location_type.py +++ b/pyrmv/enums/location_type.py @@ -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" diff --git a/pyrmv/enums/selection_mode.py b/pyrmv/enums/selection_mode.py index 0bb5f61..4bbd9fb 100644 --- a/pyrmv/enums/selection_mode.py +++ b/pyrmv/enums/selection_mode.py @@ -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"