docs: fix WQP README example unpacking and stale install instructions#296
Merged
thodson-usgs merged 1 commit intoMay 29, 2026
Merged
Conversation
README WQP examples assigned the (DataFrame, metadata) tuple to a single name, so `len(sites)` / `len(results)` printed 2 (the tuple length) instead of the row count. Unpack to `sites, metadata = ...` / `results, metadata = ...` (verified live: prints 25573 sites / 163 measurements). docs/source/meta/installing.rst referenced requirements.txt and requirements-dev.txt, which no longer exist — dependencies moved to pyproject.toml. Point the intro at [project.dependencies] and [project.optional-dependencies], replace the dev-install step with `pip install -e ".[test,doc,nldi]"`, and drop the two dangling rst link targets. The NLDI README examples (feature_source='comid') were checked against the live NLDI API and work as written (get_basin -> 1 feature, get_flowlines -> 7 flowlines), so they are intentionally left unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two documentation fixes for copy-paste-broken examples, each verified against the live API / repo. Docs only — no code changes.
README — WQP examples discarded the metadata tuple
wqp.what_sites(...)andwqp.get_results(...)return(DataFrame, WQP_Metadata), but the examples assigned the whole tuple tosites/results, solen(sites)/len(results)always printed2(the tuple length), not the row count.Fix: unpack
sites, metadata = .../results, metadata = ...(matching the Water Data examples above). Verified live — the corrected snippet printsFound 25573 stream monitoring sites in WisconsinandRetrieved 163 temperature measurements.docs/source/meta/installing.rst— referenced removedrequirements*.txtDependencies moved to
pyproject.toml, but the install guide still pointed atrequirements.txt/requirements-dev.txt(which don't exist) and instructedpip install -r requirements-dev.txt.Fix: the intro now points at
pyproject.toml([project.dependencies]+[project.optional-dependencies]); the developer install becomespip install -e ".[test,doc,nldi]"(extras confirmed present inpyproject.toml); removed the two dangling rst link targets.NLDI examples — checked and intentionally left unchanged
A review had flagged the README's
nldi.get_basin(feature_source='comid', ...)/get_flowlines(feature_source='comid', ...)as broken. Checked against the live NLDI API:comidis a valid source and both calls return data (get_basin→ 1 feature,get_flowlines→ 7 flowlines). No change made.🤖 Generated with Claude Code