fix/docs: Clarify SORTTracker deprecation status#460
Merged
Conversation
|
|
Contributor
Author
|
I have read the CLA Document and I sign the CLA. |
Member
Can you share screenshot? |
Contributor
Author
My bad, I've signed the CLA now! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies that SORTTracker itself is not deprecated, and instead deprecates the legacy tracker.trackers alias in favor of tracker.tracks, aligning the docs and API messaging with the intended public surface.
Changes:
- Added a deprecation decorator to
SORTTracker.trackers(alias fortracks). - Added documentation text clarifying that
SORTTrackeris not deprecated (onlytracker.trackersis). - Added a changelog entry describing the clarification/deprecation.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/trackers/core/sort/tracker.py |
Deprecates the trackers alias property in favor of tracks. |
docs/trackers/sort.md |
Adds a note clarifying deprecation status in the SORT docs. |
CHANGELOG.md |
Records the clarification/deprecation in the Unreleased changelog. |
- Change `deprecated_in="2.0"` to `"2.5"` — decorator first added in this PR; all other deprecations in repo use 2.5 - Move CHANGELOG entry from Added → Deprecated with corrected wording; add docs note to Fixed - Convert sort.md blockquote to `!!! note` admonition and move to after Parameters table - Add `.. deprecated:: 2.5` RST directive to `.trackers` docstring (matches botsort pattern) - Add FutureWarning regression test for `.trackers` property - Add `pydeprecate>=0.7.0` to direct runtime dependencies - Add `deprecate` to mypy `ignore_missing_imports` --- Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Borda
approved these changes
Jun 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Clarifies that
SORTTrackeritself is not deprecated. The deprecated API is only the oldtracker.trackersalias, which should be replaced withtracker.tracks.Related Issue(s): Fixes #454
What does this PR do?
Related Issue(s):
Type of Change
Testing
Checklist