Commit bbbb365
Adapt R doc for get_samples_summary, drop two doc claims that are wrong for this endpoint
Adapted the wording from R's summarize_waterdata_samples (in the develop
branch of DOI-USGS/dataRetrieval) to match the Python module's docstring
style. Picked up the variety-of-agencies example IDs from the R doc.
Two claims from the R doc were corrected rather than copied:
- The R doc says "Location identifiers should be separated with commas"
with a multi-ID example. That contradicts the function's own one-site
check and is wrong for the summary service (which accepts exactly one
ID). Dropped.
- The R doc says "Location numbers without an agency prefix are assumed
to have the prefix USGS." That's not true for this endpoint at the API
level — bare IDs return an empty result with a different column shape.
Documented the actual behavior instead.
Also switched the example to USGS-04074950 (the site used by the R doc's
example) so the two repos line up.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 491db88 commit bbbb365
1 file changed
Lines changed: 17 additions & 15 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1805 | 1805 | | |
1806 | 1806 | | |
1807 | 1807 | | |
1808 | | - | |
| 1808 | + | |
1809 | 1809 | | |
1810 | | - | |
1811 | | - | |
1812 | | - | |
1813 | | - | |
1814 | | - | |
1815 | | - | |
| 1810 | + | |
| 1811 | + | |
| 1812 | + | |
| 1813 | + | |
| 1814 | + | |
| 1815 | + | |
| 1816 | + | |
1816 | 1817 | | |
1817 | | - | |
1818 | | - | |
1819 | | - | |
1820 | | - | |
1821 | | - | |
| 1818 | + | |
| 1819 | + | |
1822 | 1820 | | |
1823 | 1821 | | |
1824 | 1822 | | |
1825 | 1823 | | |
1826 | | - | |
1827 | | - | |
| 1824 | + | |
| 1825 | + | |
| 1826 | + | |
| 1827 | + | |
| 1828 | + | |
| 1829 | + | |
1828 | 1830 | | |
1829 | 1831 | | |
1830 | 1832 | | |
| |||
1841 | 1843 | | |
1842 | 1844 | | |
1843 | 1845 | | |
1844 | | - | |
| 1846 | + | |
1845 | 1847 | | |
1846 | 1848 | | |
1847 | 1849 | | |
| |||
0 commit comments