diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 8f6c5e0beee0b..cdb0ee0b9b9cf 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -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" \ diff --git a/pandas/core/indexes/base.py b/pandas/core/indexes/base.py index c83dd3be13424..8f8b835510b60 100644 --- a/pandas/core/indexes/base.py +++ b/pandas/core/indexes/base.py @@ -4234,9 +4234,19 @@ 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). @@ -4244,6 +4254,12 @@ def join( 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 --------