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

Join documentation is misleading or wrong. #17782

Closed
implicit-apparatus opened this issue Jul 22, 2024 · 1 comment
Closed

Join documentation is misleading or wrong. #17782

implicit-apparatus opened this issue Jul 22, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@implicit-apparatus
Copy link
Contributor

Description

The description of 'semi' listed here:
https://docs.pola.rs/user-guide/transformations/joins/

semi: Returns all rows from the left frame in which the join key is also present in the right frame.

is much better than the description in the api reference:
https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.join.html#polars.DataFrame.join

semi: Filter rows that have a match in the right table.

At least I did not understand from the description reference documentation that only the left frame is taken and which rows are dropped and which rows are used (I expected the opposite). Same for 'anti'.

Link

No response

@implicit-apparatus implicit-apparatus added the documentation Improvements or additions to documentation label Jul 22, 2024
@ritchie46
Copy link
Member

Misleading... 🙄

Sure they can be improved. Do you want to make a PR?

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

No branches or pull requests

2 participants