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

Fix PR07,RT03,SA01 errors for Index.join #58469

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
Expand Up @@ -94,7 +94,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Index.get_indexer_for PR01,SA01" \
-i "pandas.Index.get_indexer_non_unique PR07,SA01" \
-i "pandas.Index.get_loc PR07,RT03,SA01" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.names GL08" \
-i "pandas.Index.putmask PR01,RT03" \
-i "pandas.Index.ravel PR01,RT03" \
Expand Down
16 changes: 16 additions & 0 deletions pandas/core/indexes/base.py
Expand Up @@ -4234,16 +4234,32 @@ def join(
Parameters
----------
other : Index
An Index object to join with the original Index.
how : {'left', 'right', 'inner', 'outer'}
Specifies the type of join to perform. It can take one of the following
values.
* left : Perform a left join, preserving the order of the original Index.
* right : Perform a right join.
* inner : Perform an inner join, retaining only the intersection of the
indices.
* outer : Perform an outer join, retaining all elements from both indices.
level : int or level name, default None
Specifies the level of a multi-index, if applicable.
return_indexers : bool, default False
A boolean indicating whether to return indexers.
sort : bool, default False
Sort the join keys lexicographically in the result Index. If False,
the order of the join keys depends on the join type (how keyword).

Returns
-------
join_index, (left_indexer, right_indexer)
The resulting Index after performing the join operation.

See Also
--------
Index.intersection : Form the intersection of two Index objects.
Index.append : Append a collection of Index options together.

Examples
--------
Expand Down