Skip to content

Commit 6027a32

Browse files
committed
small documentation edits
1 parent fb94aa0 commit 6027a32

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

dataretrieval/samples.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
44
See https://api.waterdata.usgs.gov/samples-data/docs#/ for API reference
55
6+
Not sure about avilable site types, characteristics, state codes, or other
7+
input parameters? Check out the samples data code service API reference:
8+
https://api.waterdata.usgs.gov/samples-data/codeservice/docs
9+
610
"""
711

812
from __future__ import annotations
@@ -127,16 +131,17 @@ def get_USGS_samples(
127131
projects - "project", "projectmonitoringlocationweight"
128132
organizations - "organization", "count"
129133
activityMediaName : string or list of strings, optional
130-
Name or code indicating environmental medium sample was taken.
134+
Name or code indicating environmental medium in which sample was taken.
131135
Example: "Water".
132136
activityStartDateLower : string, optional
133137
The start date if using a date range. Takes the format YYYY-MM-DD.
134138
The logic is inclusive, i.e. it will also return results that
135-
match the date.
139+
match the date. If left as None, will pull all data on or before
140+
activityStartDateUpper, of populated.
136141
activityStartDateUpper : string, optional
137142
The end date if using a date range. Takes the format YYYY-MM-DD.
138143
The logic is inclusive, i.e. it will also return results that
139-
match the date. If left as None, will pull all data before
144+
match the date. If left as None, will pull all data after
140145
activityStartDateLower up to the most recent available results.
141146
activityTypeCode : string or list of strings, optional
142147
Text code that describes type of field activity performed.

0 commit comments

Comments
 (0)