DOI-USGS / DOI-USGS/dataretrieval-python

Publish a horizon for Samples keyword aliases

Đang mở
#409 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
ready-for-agent
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

Give the deprecated Samples camelCase keyword aliases one published removal horizon through the package's shared deprecation mechanism. The aliases were introduced on 2026-08-07; use 2027-08-07, matching the repository's one-year horizon convention.

Both Samples getters must read that date from the central removal table and continue accepting and translating every legacy keyword exactly as they do now. This ticket schedules the aliases; it does not remove them or change their wire spellings.

## Acceptance criteria

- [ ] The central removal table contains one Samples-scoped horizon of 2027-08-07.
- [ ] Both Samples legacy-keyword shims emit advisories that name the usable replacement and print that horizon.
- [ ] No Samples deprecation still says only "in a future release."
- [ ] Tests obtain the expected horizon from the central table rather than duplicating the date literal.
- [ ] Every camelCase alias remains accepted and produces the same request as its snake_case replacement.
- [ ] Public signatures, parameter mappings, and Samples wire names are unchanged.
- [ ] The full offline suite and coverage gate pass.

## Blocked by

None — can start immediately.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách xác định bảng xóa trung tâm dùng chung và cả hai getter từ khóa legacy của Samples, sau đó kiểm tra các bài kiểm thử deprecation hiện có của chúng cũng như hành vi ánh xạ request. Thêm mốc 2027-08-07 duy nhất và xác minh các advisory, các bản dịch alias không thay đổi, toàn bộ offline suite và coverage gate.

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
api
Loại issue
Tính năng
Độ 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
68/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.