Skip to content

Commit 78a2ef2

Browse files
authored
DOC: ficing PR01 and SA01 issue for Index: Identical (#58442)
* DOC: ficing PR01 and SA01 issue for Index: Identical * fixing EXpected to fail issue
1 parent 46bd88f commit 78a2ef2

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9797
-i "pandas.Index.get_indexer_for PR01,SA01" \
9898
-i "pandas.Index.get_indexer_non_unique PR07,SA01" \
9999
-i "pandas.Index.get_loc PR07,RT03,SA01" \
100-
-i "pandas.Index.identical PR01,SA01" \
101100
-i "pandas.Index.join PR07,RT03,SA01" \
102101
-i "pandas.Index.names GL08" \
103102
-i "pandas.Index.putmask PR01,RT03" \

pandas/core/indexes/base.py

+11
Original file line numberDiff line numberDiff line change
@@ -5344,12 +5344,23 @@ def identical(self, other) -> bool:
53445344
"""
53455345
Similar to equals, but checks that object attributes and types are also equal.
53465346
5347+
Parameters
5348+
----------
5349+
other : Index
5350+
The Index object you want to compare with the current Index object.
5351+
53475352
Returns
53485353
-------
53495354
bool
53505355
If two Index objects have equal elements and same type True,
53515356
otherwise False.
53525357
5358+
See Also
5359+
--------
5360+
Index.equals: Determine if two Index object are equal.
5361+
Index.has_duplicates: Check if the Index has duplicate values.
5362+
Index.is_unique: Return if the index has unique values.
5363+
53535364
Examples
53545365
--------
53555366
>>> idx1 = pd.Index(["1", "2", "3"])

0 commit comments

Comments
 (0)