Skip to content

Commit 8f2bc0a

Browse files
committed
clean up documentation descriptions a little bit
1 parent a21a464 commit 8f2bc0a

1 file changed

Lines changed: 12 additions & 22 deletions

File tree

dataretrieval/waterdata/api.py

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1765,24 +1765,19 @@ def get_por_stats(
17651765
) -> Tuple[pd.DataFrame, BaseMetadata]:
17661766
"""Get day-of-year and month-of-year water data statistics from the
17671767
USGS Water Data API.
1768-
This service provides endpoints for access to computations on the
1769-
historical record regarding water conditions, including minimum, maximum,
1770-
mean, median, and percentiles for day of year, month, month-year, and
1771-
water/calendar years. For more information regarding the calculation of
1772-
statistics and other details, please visit the Statistics documentation
1773-
page: https://waterdata.usgs.gov/statistics-documentation/.
1768+
This service (called the "observationNormals" endpoint on api.waterdata.usgs.gov)
1769+
provides endpoints for access to computations on the historical record regarding
1770+
water conditions, including minimum, maximum, mean, median, and percentiles for
1771+
day of year and month of year. For more information regarding the calculation of
1772+
statistics and other details, please visit the Statistics documentation page:
1773+
https://waterdata.usgs.gov/statistics-documentation/.
17741774
17751775
Note: This API is under active beta development and subject to
17761776
change. Improved handling of significant figures will be
17771777
addressed in a future release.
17781778
17791779
Parameters
17801780
----------
1781-
service: string, One of the following options: "observationNormals"
1782-
or "observationIntervals". "observationNormals" returns
1783-
day-of-year and month-of-year statistics matching your query,
1784-
while "observationIntervals" returns monthly and annual statistics
1785-
matching your query.
17861781
approval_status: string, optional
17871782
Whether to include approved and/or provisional observations.
17881783
At this time, only approved observations are returned.
@@ -1888,24 +1883,19 @@ def get_date_range_stats(
18881883
expand_percentiles: bool = True
18891884
) -> Tuple[pd.DataFrame, BaseMetadata]:
18901885
"""Get monthly and annual water data statistics from the USGS Water Data API.
1891-
This service provides endpoints for access to computations on the
1892-
historical record regarding water conditions, including minimum, maximum,
1893-
mean, median, and percentiles for day of year, month, month-year, and
1894-
water/calendar years. For more information regarding the calculation of
1895-
statistics and other details, please visit the Statistics documentation
1896-
page: https://waterdata.usgs.gov/statistics-documentation/.
1886+
This service (called the "observationIntervals" endpoint on api.waterdata.usgs.gov)
1887+
provides endpoints for access to computations on the historical record regarding
1888+
water conditions, including minimum, maximum, mean, median, and percentiles for
1889+
month-year, and water/calendar years. For more information regarding the calculation
1890+
of statistics and other details, please visit the Statistics documentation page:
1891+
https://waterdata.usgs.gov/statistics-documentation/.
18971892
18981893
Note: This API is under active beta development and subject to
18991894
change. Improved handling of significant figures will be
19001895
addressed in a future release.
19011896
19021897
Parameters
19031898
----------
1904-
service: string, One of the following options: "observationNormals"
1905-
or "observationIntervals". "observationNormals" returns
1906-
day-of-year and month-of-year statistics matching your query,
1907-
while "observationIntervals" returns monthly and annual statistics
1908-
matching your query.
19091899
approval_status: string, optional
19101900
Whether to include approved and/or provisional observations.
19111901
At this time, only approved observations are returned.

0 commit comments

Comments
 (0)