Repository navigation
docs: document key collision edge cases in remove_duplicates_by_uniques - #556
Merged
MoralCode merged 1 commit intoOct 29, 2026
Conversation
…efs chaoss#191) Signed-off-by: CodeSparks45 <somvanshipavan2006@gmail.com>
Contributor
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.
MoralCode
approved these changes
Oct 29, 2026
Contributor
|
@drkrillo the podman thing happened here too ugh, can you submit your pr for that to this repo as well? |
2 of 3 tasks
Contributor
|
opened #557 . thanks for the ping. should have opened it right away after 8knot's |
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.
Description
This PR adds a docstring to the
remove_duplicates_by_uniquesfunction to explicitly document its known failure modes, as discussed and requested in issue #191.Specifically, it warns future developers about silent key collisions that occur because the comparison key is built using
_andstr(). This causes overlaps when:{"a": "1_2", "b": 3}and{"a": 1, "b": "2_3"}both produce"1_2_3").1vs"1", orNonevs"None").As suggested this is strictly a documentation update to provide a warning for this critical data insertion function. No core behavior or logic has been changed.
Refs #191
Notes for Reviewers
Docstring only, no behavior change. Failure modes documented as suggested in #191.
Signed commits
Generative AI disclosure
Please select one option: