DOI-USGS / DOI-USGS/dataretrieval-python

Describe parallel_chunks as chunk planning

Ouverte
#412 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
ready-for-agent
Langage dominant
Python
Étoiles
265
Forks
63
Merge moyen
1 j 20 h
PR mergées (30 j)
19

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par une recherche dans tout le dépôt de `parallel_chunks`, couvrant la documentation du package, les docstrings de l’API, les indications de configuration, les exemples et la documentation d’architecture. Ne mettez à jour que les explications qui confondent la planification des chunks avec le fan-out ou la concurrence, en préservant le langage correct sur la division ainsi que tout le comportement public. C’est terminé lorsque les recherches d’acceptation sont propres et que le build de la documentation, la suite hors ligne, le vérificateur de types, le linter, les tests d’architecture et les contrats de dépendances réussissent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
72/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.