Fix missing comma in get_reference_table doctest example#275
Merged
thodson-usgs merged 1 commit intoMay 13, 2026
Merged
Conversation
The second example block in `get_reference_table`'s docstring was
unrunnable: `collection="parameter-codes"` and `query={...}` were on
separate lines with no comma between them, so the doctest text doesn't
parse as a valid call.
Surfaced from PR DOI-USGS#229's verification pass where I executed each public
function's docstring example against the live USGS OGC API.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
0bd1c3b to
b98a27d
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes a syntax error in the get_reference_table docstring example so the illustrated multi-line function call is valid Python, improving documentation reliability for the waterdata API.
Changes:
- Add the missing comma between
collection=...andquery=...in the second example block. - Normalize the example dict quoting to double quotes for consistency within the docstring.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
The second example block in
get_reference_table's docstring is unrunnable —collection="parameter-codes"andquery={...}are on separate lines with no comma between them, so the doctest text would not parse as a valid Python call.Before (broken)
```python
After
```python
(Single quotes inside the dict are normalized to double quotes to match the rest of the file's style — drive-by, no functional change.)
Why
Surfaced while running each public-function docstring example against the live USGS OGC API as part of PR #229's verification pass.
🤖 Generated with Claude Code