Skip to content

docs(waterdata): drop R-analogue notes from getter docstrings #299

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

Merged
thodson-usgs merged 1 commit into from
May 30, 2026
Merged

docs(waterdata): drop R-analogue notes from getter docstrings #299

Show file tree
Hide file tree
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
4 changes: 0 additions & 4 deletions dataretrieval/waterdata/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1047,8 +1047,6 @@ def get_combined_metadata(

See the OpenAPI reference for the full list of supported fields:
https://api.waterdata.usgs.gov/ogcapi/v0/openapi?f=html#/combined-metadata
The R analogue is ``read_waterdata_combined_meta`` in
https://github.com/DOI-USGS/dataRetrieval/.

All ~35 location-catalog kwargs are accepted (``agency_code``,
``state_name``, ``drainage_area``, ``aquifer_code``, …) but only
Expand Down Expand Up @@ -1813,8 +1811,6 @@ def get_field_measurements_metadata(

See the OpenAPI reference for the full list of supported fields:
https://api.waterdata.usgs.gov/ogcapi/v0/openapi?f=html#/field-measurements-metadata
The R analogue is ``read_waterdata_field_meta`` in
https://github.com/DOI-USGS/dataRetrieval/.

Parameters
----------
Expand Down
6 changes: 1 addition & 5 deletions dataretrieval/waterdata/ratings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
files (``exsa``, ``base``, ``corr``) for active streamgages — see the
service overview at https://api.waterdata.usgs.gov/docs/stac/ and the
WDFN announcement at https://waterdata.usgs.gov/blog/wdfn-rating-curves/.

The R analogue is ``read_waterdata_ratings`` in
https://github.com/DOI-USGS/dataRetrieval/.
"""

from __future__ import annotations
Expand Down Expand Up @@ -65,8 +62,7 @@ def get_ratings(

See https://api.waterdata.usgs.gov/docs/stac/ for the upstream service
docs and https://waterdata.usgs.gov/blog/wdfn-rating-curves/ for the
background announcement. The R analogue is ``read_waterdata_ratings``
in https://github.com/DOI-USGS/dataRetrieval/.
background announcement.

Parameters
----------
Expand Down
Loading