Skip to content

Commit 4888130

Browse files
committed
Point get_gwlevels deprecation at continuous/daily services
The old stub only directed users to waterdata.get_field_measurements, which returns discrete/manual readings and silently drops users who need continuous transducer data. Extend the NameError and the get_record defunct-replacement table to also surface get_continuous and get_daily. Fixes #236.
1 parent c4d0f84 commit 4888130

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

dataretrieval/nwis.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -225,10 +225,13 @@ def get_discharge_peaks(
225225

226226

227227
def get_gwlevels(**kwargs):
228-
"""Defunct: use ``waterdata.get_field_measurements()``."""
228+
"""Defunct: use ``waterdata.get_continuous()``, ``waterdata.get_daily()``,
229+
or ``waterdata.get_field_measurements()``."""
229230
raise NameError(
230-
"`nwis.get_gwlevels` has been replaced "
231-
"with `waterdata.get_field_measurements()`."
231+
"`nwis.get_gwlevels` has been replaced. Use "
232+
"`waterdata.get_continuous()` for transducer (15-minute) data, "
233+
"`waterdata.get_daily()` for daily values, or "
234+
"`waterdata.get_field_measurements()` for discrete/manual readings."
232235
)
233236

234237

@@ -811,7 +814,8 @@ def get_record(
811814
- 'site' : site description
812815
- 'measurements' : (defunct) use `waterdata.get_field_measurements`
813816
- 'peaks': discharge peaks
814-
- 'gwlevels': (defunct) use `waterdata.get_field_measurements`
817+
- 'gwlevels': (defunct) use `waterdata.get_continuous`,
818+
`waterdata.get_daily`, or `waterdata.get_field_measurements`
815819
- 'pmcodes': (defunct) use `get_reference_table`
816820
- 'water_use': (defunct) no replacement available
817821
- 'ratings': get rating table
@@ -859,7 +863,11 @@ def get_record(
859863

860864
defunct_replacements = {
861865
"measurements": "`waterdata.get_field_measurements`",
862-
"gwlevels": "`waterdata.get_field_measurements`",
866+
"gwlevels": (
867+
"`waterdata.get_continuous` (transducer), "
868+
"`waterdata.get_daily`, or `waterdata.get_field_measurements` "
869+
"(discrete)"
870+
),
863871
"pmcodes": "`waterdata.get_reference_table`",
864872
"water_use": "no replacement available",
865873
}

0 commit comments

Comments
 (0)