Publish a horizon for Samples keyword aliases

Open
#409 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
api

Research direction

Start by locating the shared central removal table and both Samples legacy-keyword getters, then inspect their existing deprecation tests and request-mapping behavior. Add the single 2027-08-07 horizon and verify advisories, unchanged alias translations, the full offline suite, and the coverage gate.

Written by the indexing model from the issue text.

Description

ready-for-agent

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.

Dominant language
Python
Stars
266
Forks
63
Avg merge
1d 20h
Merged PRs (30d)
19

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DOI-USGS/dataretrieval-python

All issues in DOI-USGS/dataretrieval-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.