Replace retrieval synonyms with glossary terms

Open
#413 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start by reading parent issue #406 and the blocking issue #412 to understand the settled glossary terms. Search tracked package prose, documentation, examples, notebooks, comments, and wording-sensitive tests for the listed synonyms, preserving the explicit exclusions. Done means repository-wide searches show only intentional exclusions, documentation and notebooks build, and the offline suite, lint, type checker, and architecture checks pass.

Written by the indexing model from the issue text.

Description

ready-for-agent

Parent

#406

What to build

Replace unsupported alternate spellings of the package's core retrieval terms after the parallel_chunks explanation has been settled. Where "sub-request" denotes one piece of a split query, use chunk; where concurrency is described, use chunks in flight. Where "parallelism" denotes concurrent chunk execution, use fan-out.

Apply the correction across package prose, user documentation, examples, notebooks, comments, and wording-sensitive test messages. Preserve ordinary uses that are not synonyms, references in accepted decisions explaining rejected names, and the independent-item meaning of batch.

Acceptance criteria

  • "Sub-request" no longer denotes a chunk anywhere in tracked package, documentation, examples, notebooks, or tests.
  • Concurrency descriptions consistently use chunks in flight.
  • Uses of "parallelism" that denote concurrent chunk execution are rewritten as fan-out.
  • Accepted-decision references to rejected names and ordinary behavioral uses remain unchanged.
  • Batch terminology for independent-item skip policy remains unchanged.
  • No public identifier, parameter, environment variable, signature, or runtime behavior changes.
  • Repository-wide searches demonstrate that every remaining occurrence is an explicit exclusion rather than unresolved drift.
  • Notebooks and documentation build successfully, and the offline suite, lint, type checker, and architecture checks pass.

Blocked by

  • #412
Dominant language
Python
Stars
266
Forks
63
Avg merge
1d 20h
Merged PRs (30d)
19

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DOI-USGS/dataretrieval-python

All issues in DOI-USGS/dataretrieval-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.