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: add missing description for left join strategy #1396

Merged
merged 1 commit into from
Nov 17, 2024
Merged
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
4 changes: 3 additions & 1 deletion narwhals/dataframe.py
Original file line number Diff line number Diff line change
Expand Up @@ -1990,12 +1990,13 @@ def join(
r"""Join in SQL-like fashion.

Arguments:
other: Lazy DataFrame to join with.
other: DataFrame to join with.
on: Name(s) of the join columns in both DataFrames. If set, `left_on` and
`right_on` should be None.
how: Join strategy.

* *inner*: Returns rows that have matching values in both tables.
* *left*: Returns all rows from the left table, and the matched rows from the right table.
* *cross*: Returns the Cartesian product of rows from both tables.
* *semi*: Filter rows that have a match in the right table.
* *anti*: Filter rows that do not have a match in the right table.
Expand Down Expand Up @@ -3965,6 +3966,7 @@ def join(
how: Join strategy.

* *inner*: Returns rows that have matching values in both tables.
* *left*: Returns all rows from the left table, and the matched rows from the right table.
* *cross*: Returns the Cartesian product of rows from both tables.
* *semi*: Filter rows that have a match in the right table.
* *anti*: Filter rows that do not have a match in the right table.
Expand Down
Loading