Skip to content

docs(waterdata): point get_samples to get_codes(), not nonexistent *_lookup() helpers #303

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
Jun 1, 2026
Merged

docs(waterdata): point get_samples to get_codes(), not nonexistent *_lookup() helpers #303

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
29 changes: 12 additions & 17 deletions dataretrieval/waterdata/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2218,8 +2218,7 @@ def get_samples(
organizations - "organization", "count"
activityMediaName : string or iterable of strings, optional
Name or code indicating environmental medium in which sample was taken.
Check the `activityMediaName_lookup()` function in this module for all
possible inputs.
Call ``get_codes("samplemedia")`` for the valid inputs.
Example: "Water".
activityStartDateLower : string, optional
The start date if using a date range. Takes the format YYYY-MM-DD.
Expand All @@ -2236,13 +2235,12 @@ def get_samples(
Example: "Sample-Routine, regular".
characteristicGroup : string or iterable of strings, optional
Characteristic group is a broad category of characteristics
describing one or more results. Check the `characteristicGroup_lookup()`
function in this module for all possible inputs.
describing one or more results. Call ``get_codes("characteristicgroup")``
for the valid inputs.
Example: "Organics, PFAS"
characteristic : string or iterable of strings, optional
Characteristic is a specific category describing one or more results.
Check the `characteristic_lookup()` function in this module for all
possible inputs.
Call ``get_codes("characteristics")`` for the valid inputs.
Example: "Suspended Sediment Discharge"
characteristicUserSupplied : string or iterable of strings, optional
A user supplied characteristic name describing one or more results.
Expand All @@ -2263,27 +2261,24 @@ def get_samples(
countryFips : string or iterable of strings, optional
Example: "US" (United States)
stateFips : string or iterable of strings, optional
Check the `stateFips_lookup()` function in this module for all
possible inputs.
Call ``get_codes("states")`` for the valid inputs.
Example: "US:15" (United States: Hawaii)
countyFips : string or iterable of strings, optional
Check the `countyFips_lookup()` function in this module for all
possible inputs.
Call ``get_codes("counties")`` for the valid inputs.
Example: "US:15:001" (United States: Hawaii, Hawaii County)
siteTypeCode : string or iterable of strings, optional
An abbreviation for a certain site type. Check the `siteType_lookup()`
function in this module for all possible inputs.
An abbreviation for a certain site type. Call ``get_codes("sitetype")``
for the valid inputs.
Example: "GW" (Groundwater site)
siteTypeName : string or iterable of strings, optional
A full name for a certain site type. Check the `siteType_lookup()`
function in this module for all possible inputs.
A full name for a certain site type. Call ``get_codes("sitetype")``
for the valid inputs.
Example: "Well"
usgsPCode : string or iterable of strings, optional
5-digit number used in the US Geological Survey computerized
data system, National Water Information System (NWIS), to
uniquely identify a specific constituent. Check the
`characteristic_lookup()` function in this module for all possible
inputs.
uniquely identify a specific constituent (the ``parameterCode`` column
of ``get_codes("characteristics")``).
Example: "00060" (Discharge, cubic feet per second)
hydrologicUnit : string or iterable of strings, optional
Max 12-digit number used to describe a hydrologic unit.
Expand Down
Loading