Skip to content

Commit 47c4df9

Browse files
committed
Improve pandas.Index.is_ docstring
1 parent 7d9c200 commit 47c4df9

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

pandas/core/indexes/base.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -545,11 +545,17 @@ def is_(self, other) -> bool:
545545
Parameters
546546
----------
547547
other : object
548-
other object to compare against.
548+
Other object to compare against.
549549
550550
Returns
551551
-------
552-
True if both have same underlying data, False otherwise : bool
552+
bool
553+
Boolean indicating if both object have same underlying data,
554+
False otherwise.
555+
556+
See Also
557+
--------
558+
Index.identical : Works like Index.is_ but also check metadata.
553559
"""
554560
# use something other than None to be clearer
555561
return self._id is getattr(other, "_id", Ellipsis) and self._id is not None

0 commit comments

Comments
 (0)