Skip to content

DOC: Additional "merge_asof" Docs Explaination #62753

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+14 −8
Open

DOC: Additional "merge_asof" Docs Explaination #62753

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1cd66a1
Additional "merge_asof" docs explaination
zephyrieal Oct 19, 2025
c9663dc
Remove whitespace
zephyrieal Oct 19, 2025
904346f
remove additional whitespaces
zephyrieal Oct 19, 2025
d4831b6
remove double spaces
zephyrieal Oct 19, 2025
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
22 changes: 14 additions & 8 deletions pandas/core/reshape/merge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,9 @@ def merge_asof(
Perform a merge by key distance.

This is similar to a left-join except that we match on nearest
key rather than equal keys. Both DataFrames must be sorted by the key.
key rather than equal keys. Both DataFrames must be first sorted by
the merge key in ascending order before calling this function.
Sorting by any additional 'by' grouping columns is not required.

For each row in the left DataFrame:

Expand All @@ -700,19 +702,22 @@ def merge_asof(
Second pandas object to merge.
on : label
Field name to join on. Must be found in both DataFrames.
The data MUST be ordered. Furthermore this must be a numeric column,
such as datetimelike, integer, or float. On or left_on/right_on
must be given.
The data MUST be in ascending order. Furthermore this must be
a numeric column, such as datetimelike, integer, or float. 'on'
or 'left_on' / 'right_on' must be given.
left_on : label
Field name to join on in left DataFrame.
Field name to join on in left DataFrame. If specified, sort the left
DataFrame by this column in ascending order before merging.
right_on : label
Field name to join on in right DataFrame.
Field name to join on in right DataFrame. If specified, sort the right
DataFrame by this column in ascending order before merging.
left_index : bool
Use the index of the left DataFrame as the join key.
right_index : bool
Use the index of the right DataFrame as the join key.
by : column name or list of column names
Match on these columns before performing merge operation.
Match on these columns before performing merge operation. It is not required
to sort by these columns.
left_by : column name
Field names to match on in the left DataFrame.
right_by : column name
Expand All @@ -736,7 +741,8 @@ def merge_asof(
Returns
-------
DataFrame
A DataFrame of the two merged objects.
A DataFrame of the two merged objects, containing all rows from the
left DataFrame and the nearest matches from the right DataFrame.

See Also
--------
Expand Down
Loading