Skip to content

Commit

Permalink
docs: Add missing join strategy.
Browse files Browse the repository at this point in the history
  • Loading branch information
haimjether committed Jul 30, 2024
1 parent 82b6388 commit 1ddad48
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion py-polars/polars/dataframe/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -6736,7 +6736,7 @@ def join(
DataFrame to join with.
on
Name(s) of the join columns in both DataFrames.
how : {'inner', 'left', 'right', 'full', 'semi', 'anti', 'cross'}
how : {'inner', 'left', 'right', 'full', 'semi', 'anti', 'cross', 'outer'}
Join strategy.
* *inner*
Expand All @@ -6755,6 +6755,11 @@ def join(
Returns rows from the left table that have a match in the right table.
* *anti*
Returns rows from the left table that have no match in the right table.
* *outer*
Returns all rows from both tables, with matching rows from both sides
where available.
Non-matching rows will have nulls in the columns from the table that
does not have a match.
.. note::
A left join preserves the row order of the left DataFrame.
Expand Down

0 comments on commit 1ddad48

Please sign in to comment.