Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of isequal for comparisons #3313

Merged
merged 1 commit into from
Apr 19, 2023
Merged

Conversation

knuesel
Copy link
Contributor

@knuesel knuesel commented Apr 12, 2023

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 the innerjoin and outerjoin docstrings).

The isequal sentence in the matchmissing bullet point seemed redundant so I removed it, but please check, maybe I misunderstood its meaning.

src/join/composer.jl Outdated Show resolved Hide resolved
@bkamins bkamins added the doc label Apr 13, 2023
@bkamins bkamins added this to the 1.6 milestone Apr 13, 2023
@bkamins
Copy link
Member

bkamins commented Apr 13, 2023

Looks good. Let us wait for @nalimilan to comment on the language.
I left one small other improvement that we could also make (on can be multiple columns).

@knuesel
Copy link
Contributor Author

knuesel commented Apr 14, 2023

I've reworded the on paragraph as per the discussion above. The text is now generic from the start regarding the number of columns.

@bkamins bkamins requested a review from nalimilan April 14, 2023 12:06
@bkamins bkamins merged commit 2b480f2 into JuliaData:main Apr 19, 2023
@bkamins
Copy link
Member

bkamins commented Apr 19, 2023

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants