API: Always allow sorted=False and make a note about it
#28503
Merged
Conversation
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
User intent for `sorted=False` is very clear, so I think we can really just allow it. However, note in the docs that it could change. Also add a bigger note in the `unique_*` functions that still always return a sorted result but would change in the future (whenever `sorted=False` does work).
|
CC @adrinjalali for awareness. |
mhvk
approved these changes
Mar 14, 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.
User intent for
sorted=Falseis very clear, so I think we can really just allow it.However, note in the docs that it could change. Also add a bigger note in the
unique_*functions that still always return a sorted result but would change in the future (wheneversorted=Falsedoes work).This is a small follow up to gh-26018 and gh-28493 (and the original addition of the
unique_*family of functions, that always should have warned about the potential of API evolution).