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

docs(python): Reword "how" param docstring entry for 'semi' and 'anti' join types for clarity #17843

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions py-polars/polars/dataframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -6681,13 +6681,13 @@ def join(
Returns all rows from the right table, and the matched rows from the
left table
* *full*
Returns all rows when there is a match in either left or right table
Returns all rows when there is a match in either left or right table
* *cross*
Returns the Cartesian product of rows from both tables
Returns the Cartesian product of rows from both tables
* *semi*
Filter rows that have a match in the right table.
Returns rows from the left table that have a match in the right table.
* *anti*
Filter rows that do not have a match in the right table.
Returns rows from the left table that have no match in the right table.

.. note::
A left join preserves the row order of the left DataFrame.
Expand Down
8 changes: 4 additions & 4 deletions py-polars/polars/lazyframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -4074,13 +4074,13 @@ def join(
Returns all rows from the right table, and the matched rows from the
left table
* *full*
Returns all rows when there is a match in either left or right table
Returns all rows when there is a match in either left or right table
* *cross*
Returns the Cartesian product of rows from both tables
Returns the Cartesian product of rows from both tables
* *semi*
Filter rows that have a match in the right table.
Returns rows from the left table that have a match in the right table.
* *anti*
Filter rows that not have a match in the right table.
Returns rows from the left table that have no match in the right table.

.. note::
A left join preserves the row order of the left DataFrame.
Expand Down