Skip to content

Commit 74ee7e8

Browse files
committed
Improve pandas.Index.is_ docstring
1 parent ca60688 commit 74ee7e8

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
@@ -547,11 +547,17 @@ def is_(self, other) -> bool:
547547
Parameters
548548
----------
549549
other : object
550-
other object to compare against.
550+
Other object to compare against.
551551
552552
Returns
553553
-------
554-
True if both have same underlying data, False otherwise : bool
554+
bool
555+
Boolean indicating if both object have same underlying data,
556+
False otherwise.
557+
558+
See Also
559+
--------
560+
Index.identical : Works like Index.is_ but also check metadata.
555561
"""
556562
# use something other than None to be clearer
557563
return self._id is getattr(other, "_id", Ellipsis) and self._id is not None

0 commit comments

Comments
 (0)