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

DOC: ficing PR01 and SA01 issue for Index: Identical #58442

Merged
merged 3 commits into from Apr 30, 2024
Merged
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 @@ -98,7 +98,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.identical PR01,SA01" \
-i "pandas.Index.join PR07,RT03,SA01" \
-i "pandas.Index.names GL08" \
-i "pandas.Index.nunique RT03" \
Expand Down
11 changes: 11 additions & 0 deletions pandas/core/indexes/base.py
Expand Up @@ -5343,12 +5343,23 @@ def identical(self, other) -> bool:
"""
Similar to equals, but checks that object attributes and types are also equal.

Parameters
----------
other : Index
The Index object you want to compare with the current Index object.

Returns
-------
bool
If two Index objects have equal elements and same type True,
otherwise False.

See Also
--------
Index.equals: Determine if two Index object are equal.
Index.has_duplicates: Check if the Index has duplicate values.
Index.is_unique: Return if the index has unique values.

Examples
--------
>>> idx1 = pd.Index(["1", "2", "3"])
Expand Down