Skip to content

Commit 666fbd5

Browse files
thodson-usgsclaude
andcommitted
docs(waterdata): drop R-analogue notes from getter docstrings
The combined-metadata, field-measurements-metadata, and ratings docstrings (and the ratings module docstring) each pointed at their R dataRetrieval counterpart. Those cross-package references don't help a Python caller reading help(...), and the other getters don't carry them, so remove them and let each docstring describe the function on its own terms. The OpenAPI/service reference links and the Python-to-Python "analogue to get_time_series_metadata" cross-reference are kept. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 484a86a commit 666fbd5

2 files changed

Lines changed: 1 addition & 9 deletions

File tree

dataretrieval/waterdata/api.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1047,8 +1047,6 @@ def get_combined_metadata(
10471047
10481048
See the OpenAPI reference for the full list of supported fields:
10491049
https://api.waterdata.usgs.gov/ogcapi/v0/openapi?f=html#/combined-metadata
1050-
The R analogue is ``read_waterdata_combined_meta`` in
1051-
https://github.com/DOI-USGS/dataRetrieval/.
10521050
10531051
All ~35 location-catalog kwargs are accepted (``agency_code``,
10541052
``state_name``, ``drainage_area``, ``aquifer_code``, …) but only
@@ -1813,8 +1811,6 @@ def get_field_measurements_metadata(
18131811
18141812
See the OpenAPI reference for the full list of supported fields:
18151813
https://api.waterdata.usgs.gov/ogcapi/v0/openapi?f=html#/field-measurements-metadata
1816-
The R analogue is ``read_waterdata_field_meta`` in
1817-
https://github.com/DOI-USGS/dataRetrieval/.
18181814
18191815
Parameters
18201816
----------

dataretrieval/waterdata/ratings.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
files (``exsa``, ``base``, ``corr``) for active streamgages — see the
66
service overview at https://api.waterdata.usgs.gov/docs/stac/ and the
77
WDFN announcement at https://waterdata.usgs.gov/blog/wdfn-rating-curves/.
8-
9-
The R analogue is ``read_waterdata_ratings`` in
10-
https://github.com/DOI-USGS/dataRetrieval/.
118
"""
129

1310
from __future__ import annotations
@@ -65,8 +62,7 @@ def get_ratings(
6562
6663
See https://api.waterdata.usgs.gov/docs/stac/ for the upstream service
6764
docs and https://waterdata.usgs.gov/blog/wdfn-rating-curves/ for the
68-
background announcement. The R analogue is ``read_waterdata_ratings``
69-
in https://github.com/DOI-USGS/dataRetrieval/.
65+
background announcement.
7066
7167
Parameters
7268
----------

0 commit comments

Comments
 (0)