Skip to content

Commit 77113bc

Browse files
gullotjuftin
authored andcommitted
cleaned up docstrings of _get_searchable_campgrounds, _get_campgrounds_by_campground_id, _get_campgrounds_by_campsite_id, and _get_campgrounds_by_recreation_id
1 parent e0a7ab5 commit 77113bc

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

camply/search/search_recreationdotgov.py

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def _get_searchable_campgrounds(self) -> List[CampgroundFacility]:
121121
122122
Returns
123123
-------
124-
searchable_campgrounds: List[int]
124+
searchable_campgrounds: List[CampgroundFacility]
125125
List of searchable campground IDs
126126
"""
127127
if self.campsites not in [(), [], None]:
@@ -185,11 +185,11 @@ def _get_searchable_equipment(
185185

186186
def _get_campgrounds_by_campground_id(self) -> List[CampgroundFacility]:
187187
"""
188-
Return a List of Campgrounds to search when provided with campground IDs
188+
Return a List of Campgrounds to search when provided with Campground IDs
189189
190190
Returns
191191
-------
192-
returned_sites: List[int]
192+
facilities: List[CampgroundFacility]
193193
List of searchable campground IDs
194194
"""
195195
campground_list = make_list(self._campground_object)
@@ -204,7 +204,7 @@ def _get_campgrounds_by_campsite_id(self) -> List[CampgroundFacility]:
204204
205205
Returns
206206
-------
207-
returned_sites: List[int]
207+
facilities: List[CampgroundFacility]
208208
List of searchable campground IDs
209209
"""
210210
campsite_list = make_list(self.campsites)
@@ -217,15 +217,16 @@ def _get_campgrounds_by_recreation_area_id(self) -> List[CampgroundFacility]:
217217
218218
Returns
219219
-------
220-
campgrounds: List[CampgroundFacility]
220+
facilities: List[CampgroundFacility]
221+
List of searchable campground IDs
221222
"""
222-
campgrounds = []
223+
facilities = []
223224
for rec_area in self._recreation_area_id:
224225
campground_array = self.campsite_finder.find_facilities_per_recreation_area(
225226
rec_area_id=rec_area
226227
)
227-
campgrounds += campground_array
228-
return campgrounds
228+
facilities += campground_array
229+
return facilities
229230

230231
def get_all_campsites(self) -> List[AvailableCampsite]:
231232
"""

0 commit comments

Comments
 (0)