DOC: Link pandas.merge
API page to User Guide (:ref:merging
)
#62379
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds a cross-link from the
pandas.merge
API reference (See also section) to the User Guide section:ref:
merging`` (“Merge, join, concatenate and compare”) to improve discoverability for new users.What’s changed
pandas/core/reshape/merge.py
merge
docstring’s See also block, add::ref:
merging: User Guide on merging, joining, concatenating, and comparing.
Rationale
The API page currently lists related functions but not the tutorial-style User Guide page. Adding the
:ref:
merging`` link makes it easier to jump from API to the relevant guide.Notes
DataFrame.join
and related functions.