Skip to content

Commit c23e56c

Browse files
authored
docs: Correct sortedness requirement for join_asof (#2457)
1 parent 1de571b commit c23e56c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

narwhals/dataframe.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1717,7 +1717,8 @@ def join_asof(
17171717
17181718
This is similar to a left-join except that we match on nearest key rather than equal keys.
17191719
1720-
Both DataFrames must be sorted by the asof_join key.
1720+
For Polars, both DataFrames must be sorted by the `on` key (within each `by` group
1721+
if specified).
17211722
17221723
Arguments:
17231724
other: DataFrame to join with.
@@ -3034,7 +3035,8 @@ def join_asof(
30343035
30353036
This is similar to a left-join except that we match on nearest key rather than equal keys.
30363037
3037-
Both DataFrames must be sorted by the asof_join key.
3038+
For Polars, both DataFrames must be sorted by the `on` key (within each `by` group
3039+
if specified).
30383040
30393041
Arguments:
30403042
other: DataFrame to join with.

0 commit comments

Comments
 (0)