docs: fix noun-stack over 3 modifiers in metadata docstring - #414
Closed
thodson-usgs wants to merge 1 commit into
Closed
docs: fix noun-stack over 3 modifiers in metadata docstring#414thodson-usgs wants to merge 1 commit into
thodson-usgs wants to merge 1 commit into
Conversation
'USGS water resources data base' stacked four modifiers before the head noun. Rewritten with a prepositional phrase: 'USGS database of water resources'.
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.
Summary
Repo-wide review for noun stacks deeper than 3 modifiers before a head noun (per the style rule: cap at three modifiers, convert the rest to a prepositional phrase).
Scanned prose across
README.md,AGENTS.md,CONTEXT.md,CONTRIBUTING.md,NEWS.md,docs/source/**, and every docstring/comment indataretrieval/. The corpus is deliberately edited prose (per the domain-modeling/writing-for-agents conventions already in place) and almost entirely clean. Found one genuine violation:dataretrieval/waterdata/metadata.py(get_monitoring_locationsdocstring,aquifer_codeparameter): "the USGS water resources data base" — four modifiers (USGS,water,resources,data) stacked before the head nounbase. Rewritten as "the USGS database of water resources", converting one modifier into a prepositional phrase. Also fixes the stray "data base" → "database" spelling inconsistency with the rest of the codebase.Not changed (reviewed and kept as-is)
NEWS.md) and its recurrences indataretrieval/waterdata/ratings.py,dataretrieval/rdb.py, and demos: technically 4 modifiers before "catalog," butWater Datais a frozen core-term/service name (CONTEXT.md) andSTACis a fixed external standard's acronym — this is one consistently-used compound proper noun, not an arbitrary stack, and it appears identically across multiple files. Rewriting it in one spot would create inconsistency without a clear readability gain.R/dataRetrieval/man/*.RdandR/dataRetrieval/vignettes/*.Rmdis out of scope —AGENTS.mdexplicitly marksR/as untracked local scratch, not part of this repo.Testing
ruff format --check/ruff checkpass on the changed file.