Document use of isequal for comparisons #3313
Merged
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.
This documents that the join functions use
isequal
for key comparisons. It also adds a note that joining on floating point values is not recommended.I also added the "
on
is a required argument" sentence to all the relevant docstrings (previously it was only included in theinnerjoin
andouterjoin
docstrings).The
isequal
sentence in thematchmissing
bullet point seemed redundant so I removed it, but please check, maybe I misunderstood its meaning.