DOI-USGS / DOI-USGS/dataretrieval-python
Use adapter terminology for configuration scope
- 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ả
## Parent
#406
## What to build
Correct configuration prose, comments, and caller-facing guidance that describe a setting or default as scoped to a service when the package's configuration scope is the adapter. Preserve uses of "service" that genuinely name an external system, host behavior, upstream capacity, or service-neutral machinery.
The caller-facing invalid-configuration remedy must name real configuration objects and remain literally actionable. This is a wording correction only: do not rename identifiers, configuration classes, settings, adapter keys, or public parameters.
## Acceptance criteria
- [ ] Every configuration use of "service" names an external system rather than the scope of a setting, default, profile, or override.
- [ ] Every tuning-scope explanation consistently says adapter or names the adapter's configuration.
- [ ] The invalid-configuration remedy names valid package-wide and adapter-specific configuration objects, and following it produces a working call.
- [ ] Legitimate external-service, gateway, host, and service-neutral wording is unchanged.
- [ ] No public identifier, parameter, class, setting, configuration grammar, or behavior changes.
- [ ] The change description records that facade, leaf, and configuration-profile usage were audited and found compliant rather than mechanically rewritten.
- [ ] Documentation, wording-sensitive tests, the offline suite, lint, and architecture checks 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 cách tìm các chỗ sử dụng “service” trong phần diễn đạt về cấu hình, các chú thích và hướng dẫn dành cho bên gọi; sau đó xác định các bài kiểm thử nhạy cảm với cách diễn đạt và các tệp tài liệu liên quan. Kiểm tra việc sử dụng facade, leaf và configuration-profile mà không thay đổi mã định danh hoặc hành vi; chạy các bước kiểm tra tài liệu, các bài kiểm thử nhạy cảm với cách diễn đạt, bộ kiểm thử ngoại tuyến, lint và các bước kiểm tra kiến trúc, đồng thời xác nhận rằng biện pháp khắc phục cấu hình không hợp lệ có thể thực hiện được.
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ó
- 4/5
- Thời gian dự kiến
- 3-5 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
- 48/100