Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Documentation Update - search_recreationdotgov.py methods #364

Merged
merged 1 commit into from
Dec 11, 2024
Merged

📝 Documentation Update - search_recreationdotgov.py methods #364

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions camply/search/search_recreationdotgov.py
View file
Open in desktop
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
Loading