DOI-USGS / DOI-USGS/dataretrieval-python

Describe parallel_chunks as chunk planning

Aperta
#412 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
ready-for-agent
Lingua principale
Python
Stelle
265
Fork
63
Merge medio
1g 20h
PR unite (30g)
19

Descrizione

## What to build

Align every explanation of `parallel_chunks` with the accepted chunking/fan-out boundary. The setting refines a query plan into more, smaller chunks; it does not execute those chunks concurrently. Fan-out performs execution, and the concurrency setting separately limits how many chunks are in flight.

Audit package documentation, API docstrings, configuration guidance, examples, and architecture prose. Preserve the public name and all behavior. Rewrite only passages that attribute execution or concurrency to the planning dial; leave already-correct division language unchanged.

## Acceptance criteria

- [ ] Every explanation frames `parallel_chunks` as optional chunk-plan refinement or a target chunk count.
- [ ] No explanation says the setting itself performs fan-out or parallel execution.
- [ ] Where performance is discussed, the prose clearly distinguishes more chunks from the separate concurrency cap and fan-out executor.
- [ ] Already-correct chunking descriptions remain intact.
- [ ] The public symbol, signatures, defaults, quota behavior, and execution behavior are unchanged.
- [ ] README and user-guide examples retain their existing calls and rendered behavior.
- [ ] Repository searches find no remaining planning/fan-out conflation around this setting.
- [ ] The documentation build, offline suite, type checker, linter, architecture tests, and dependency contracts pass.

## Blocked by

None — can start immediately.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia con una ricerca nell’intero repository di `parallel_chunks`, includendo la documentazione del package, i docstring dell’API, le indicazioni di configurazione, gli esempi e la documentazione dell’architettura. Aggiorna solo le spiegazioni che confondono la pianificazione dei chunk con il fan-out o la concorrenza, mantenendo il linguaggio corretto sulla suddivisione e tutto il comportamento pubblico. Il lavoro è completato quando le ricerche di accettazione non restituiscono risultati e superano correttamente il build della documentazione, la suite offline, il type checker, il linter, i test dell’architettura e i contratti delle dipendenze.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
72/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.