Document and check resource comparability #6272
Merged
Conversation
This file contains 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
Ensure backwards compatibility by adding a compile-time check that the Resource remains comparable. Document the shortcomings of direct comparison of a Resource.
MrAlias
requested review from
XSAM,
dashpole,
pellared and
dmathieu
as code owners
dashpole
reviewed
Feb 5, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6272 +/- ##
=====================================
Coverage 81.8% 81.8%
=====================================
Files 283 283
Lines 24892 24892
=====================================
Hits 20379 20379
Misses 4109 4109
Partials 404 404 |
XSAM
approved these changes
Feb 5, 2025
pellared
approved these changes
Feb 5, 2025
Model it after time.Time
pellared
approved these changes
Feb 5, 2025
dmathieu
approved these changes
Feb 6, 2025
dashpole
approved these changes
Feb 6, 2025
|
How about making a changelog entry for this so that we give more chance for users to proactively change their codebases? |
What do you suggest? |
|
Something like: Document the pitfalls of using Resource as a comparable type. Favor its Equal and Equivalent methods instead. |
|
Updated PTAL. |
pellared
approved these changes
Feb 12, 2025
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.
Ensure backwards compatibility by adding a compile-time check that the Resource remains comparable.
Document the shortcomings of direct comparison of a Resource.