docs(waterdata): drop R-analogue notes from getter docstrings#299
Merged
thodson-usgs merged 1 commit intoMay 30, 2026
Merged
Conversation
The combined-metadata, field-measurements-metadata, and ratings docstrings (and the ratings module docstring) each pointed at their R dataRetrieval counterpart. Those cross-package references don't help a Python caller reading help(...), and the other getters don't carry them, so remove them and let each docstring describe the function on its own terms. The OpenAPI/service reference links and the Python-to-Python "analogue to get_time_series_metadata" cross-reference are kept. 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
Removes the "The R analogue is
read_waterdata_…" notes from three Water Data getter docstrings and theratingsmodule docstring:get_combined_metadataget_field_measurements_metadataget_ratings(and theratings.pymodule docstring)These cross-package pointers to R
dataRetrievaldon't help a Python caller readinghelp(...), and the other getters (get_daily,get_continuous,get_waterdata, …) don't carry them — so this makes the docstrings consistent and lets each describe the function on its own terms.Kept intentionally:
get_field_measurements_metadata("the discrete-measurement analogue toget_time_series_metadata"), which points at a related function in this package.Docstrings only — no code or signature changes.
ruffclean; imports verified.🤖 Generated with Claude Code