DOI-USGS / DOI-USGS/dataretrieval-python
Describe parallel_chunks as chunk planning
- Ngôn ngữ chính
- Python
- Star
- 265
- Fork
- 63
- Merge trung bình
- 1 ngày 20 giờ
- Pull request đã merge (30 ngày)
- 19
Mô tả
## 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.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng việc tìm kiếm trên toàn bộ repository đối với `parallel_chunks`, bao quát tài liệu package, các docstring của API, hướng dẫn cấu hình, ví dụ và phần mô tả kiến trúc. Chỉ cập nhật những phần giải thích đánh đồng việc lập kế hoạch chunk với fan-out hoặc tính đồng thời, đồng thời giữ nguyên cách diễn đạt chính xác về việc chia và toàn bộ hành vi công khai. Hoàn tất khi các tìm kiếm chấp nhận không còn kết quả cần xử lý và quá trình build tài liệu, bộ kiểm thử offline, trình kiểm tra kiểu, linter, các bài kiểm thử kiến trúc và các hợp đồng dependency đều vượt qua.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Sôi nổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 72/100