From 9385b5ebc6a61824e88e62e6b7cebe261d12026b Mon Sep 17 00:00:00 2001 From: gullot Date: Tue, 3 Dec 2024 11:00:24 -0800 Subject: [PATCH] cleaned up docstrings of _get_searchable_campgrounds, _get_campgrounds_by_campground_id, _get_campgrounds_by_campsite_id, and _get_campgrounds_by_recreation_id --- camply/search/search_recreationdotgov.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/camply/search/search_recreationdotgov.py b/camply/search/search_recreationdotgov.py index c3b3b401..d56ef487 100644 --- a/camply/search/search_recreationdotgov.py +++ b/camply/search/search_recreationdotgov.py @@ -121,7 +121,7 @@ def _get_searchable_campgrounds(self) -> List[CampgroundFacility]: Returns ------- - searchable_campgrounds: List[int] + searchable_campgrounds: List[CampgroundFacility] List of searchable campground IDs """ if self.campsites not in [(), [], None]: @@ -185,11 +185,11 @@ def _get_searchable_equipment( def _get_campgrounds_by_campground_id(self) -> List[CampgroundFacility]: """ - Return a List of Campgrounds to search when provided with campground IDs + Return a List of Campgrounds to search when provided with Campground IDs Returns ------- - returned_sites: List[int] + facilities: List[CampgroundFacility] List of searchable campground IDs """ campground_list = make_list(self._campground_object) @@ -204,7 +204,7 @@ def _get_campgrounds_by_campsite_id(self) -> List[CampgroundFacility]: Returns ------- - returned_sites: List[int] + facilities: List[CampgroundFacility] List of searchable campground IDs """ campsite_list = make_list(self.campsites) @@ -217,15 +217,16 @@ def _get_campgrounds_by_recreation_area_id(self) -> List[CampgroundFacility]: Returns ------- - campgrounds: List[CampgroundFacility] + facilities: List[CampgroundFacility] + List of searchable campground IDs """ - campgrounds = [] + facilities = [] for rec_area in self._recreation_area_id: campground_array = self.campsite_finder.find_facilities_per_recreation_area( rec_area_id=rec_area ) - campgrounds += campground_array - return campgrounds + facilities += campground_array + return facilities def get_all_campsites(self) -> List[AvailableCampsite]: """