Skip to content

Commit

Permalink
cleaned up docstrings of _get_searchable_campgrounds, _get_campground…
Browse files Browse the repository at this point in the history
…s_by_campground_id, _get_campgrounds_by_campsite_id, and _get_campgrounds_by_recreation_id
  • Loading branch information
gullot committed Dec 3, 2024
1 parent ba4f250 commit 9385b5e
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions camply/search/search_recreationdotgov.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]:
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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]:
"""
Expand Down

0 comments on commit 9385b5e

Please sign in to comment.