DOI-USGS / DOI-USGS/dataretrieval-python

Replace retrieval synonyms with glossary terms

オープン
#413 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
ready-for-agent
主要言語
Python
スター
265
フォーク
63
平均マージ
1日 20時間
マージ済み PR(30日)
19

説明

## 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

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まず親 issue #406 とブロッキング issue #412 を読んで、確定した用語集の用語を理解します。Git で追跡されているパッケージの文章、ドキュメント、例、ノートブック、コメント、表現に依存するテストを対象に、列挙された同義語を検索し、明示された除外を維持します。リポジトリ全体の検索結果が意図した除外だけを示し、ドキュメントとノートブックがビルドされ、オフラインスイート、lint、型チェッカー、アーキテクチャチェックがすべて成功すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。