Skip to content

Commit

Permalink
DOC: improve Index docstrings (#50720)
Browse files Browse the repository at this point in the history
* DOC: improve Index docstrings

* fix example

* update Series.hanans docstring
  • Loading branch information
abonte authored Jan 16, 2023
1 parent 13f5395 commit d95ff3e
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 6 deletions.
4 changes: 4 additions & 0 deletions pandas/core/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -784,6 +784,10 @@ def hasnans(self) -> bool:
Return True if there are any NaNs.
Enables various performance speedups.
Returns
-------
bool
"""
# error: Item "bool" of "Union[bool, ndarray[Any, dtype[bool_]], NDFrame]"
# has no attribute "any"
Expand Down
64 changes: 58 additions & 6 deletions pandas/core/indexes/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -2041,13 +2041,21 @@ def is_monotonic_increasing(self) -> bool:
"""
Return a boolean if the values are equal or increasing.
Returns
-------
bool
See Also
--------
Index.is_monotonic_decreasing : Check if the values are equal or decreasing.
Examples
--------
>>> Index([1, 2, 3]).is_monotonic_increasing
>>> pd.Index([1, 2, 3]).is_monotonic_increasing
True
>>> Index([1, 2, 2]).is_monotonic_increasing
>>> pd.Index([1, 2, 2]).is_monotonic_increasing
True
>>> Index([1, 3, 2]).is_monotonic_increasing
>>> pd.Index([1, 3, 2]).is_monotonic_increasing
False
"""
return self._engine.is_monotonic_increasing
Expand All @@ -2057,13 +2065,21 @@ def is_monotonic_decreasing(self) -> bool:
"""
Return a boolean if the values are equal or decreasing.
Returns
-------
bool
See Also
--------
Index.is_monotonic_increasing : Check if the values are equal or increasing.
Examples
--------
>>> Index([3, 2, 1]).is_monotonic_decreasing
>>> pd.Index([3, 2, 1]).is_monotonic_decreasing
True
>>> Index([3, 2, 2]).is_monotonic_decreasing
>>> pd.Index([3, 2, 2]).is_monotonic_decreasing
True
>>> Index([3, 1, 2]).is_monotonic_decreasing
>>> pd.Index([3, 1, 2]).is_monotonic_decreasing
False
"""
return self._engine.is_monotonic_decreasing
Expand Down Expand Up @@ -2108,6 +2124,34 @@ def _is_strictly_monotonic_decreasing(self) -> bool:
def is_unique(self) -> bool:
"""
Return if the index has unique values.
Returns
-------
bool
See Also
--------
Index.has_duplicates : Inverse method that checks if it has duplicate values.
Examples
--------
>>> idx = pd.Index([1, 5, 7, 7])
>>> idx.is_unique
False
>>> idx = pd.Index([1, 5, 7])
>>> idx.is_unique
True
>>> idx = pd.Index(["Watermelon", "Orange", "Apple",
... "Watermelon"]).astype("category")
>>> idx.is_unique
False
>>> idx = pd.Index(["Orange", "Apple",
... "Watermelon"]).astype("category")
>>> idx.is_unique
True
"""
return self._engine.is_unique

Expand All @@ -2122,6 +2166,10 @@ def has_duplicates(self) -> bool:
bool
Whether or not the Index has duplicate values.
See Also
--------
Index.is_unique : Inverse method that checks if it has unique values.
Examples
--------
>>> idx = pd.Index([1, 5, 7, 7])
Expand Down Expand Up @@ -2547,6 +2595,10 @@ def hasnans(self) -> bool:
Return True if there are any NaNs.
Enables various performance speedups.
Returns
-------
bool
"""
if self._can_hold_na:
return bool(self._isnan.any())
Expand Down

0 comments on commit d95ff3e

Please sign in to comment.