DOC: add alternative to docstring of deprecated Series.bool() method (p…

…andas-dev#55168) * Fix for series boolean documentation * one blank line removed. docstring error * Update pandas/core/generic.py fixing text formating Co-authored-by: Matthew Roeschke <[email protected]> * Update pandas/core/generic.py text formatting fixed Co-authored-by: Matthew Roeschke <[email protected]> --------- Co-authored-by: Matthew Roeschke <[email protected]>
hedeershowk · Sep 20, 2023 · b6c08a9 · b6c08a9
1 parent 45cf653
commit b6c08a9
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/pandas/core/generic.py b/pandas/core/generic.py
@@ -1526,7 +1526,8 @@ def bool(self) -> bool_t:
 
         .. deprecated:: 2.1.0
 
-           bool is deprecated and will be removed in future version of pandas
+           bool is deprecated and will be removed in future version of pandas.
+           For ``Series`` use ``pandas.Series.item``.
 
         This must be a boolean scalar value, either True or False. It will raise a
         ValueError if the Series or DataFrame does not have exactly 1 element, or that
@@ -1556,6 +1557,14 @@ def bool(self) -> bool_t:
         True
         >>> pd.DataFrame({'col': [False]}).bool()  # doctest: +SKIP
         False
+
+        This is an alternative method and will only work
+        for single element objects with a boolean value:
+
+        >>> pd.Series([True]).item()  # doctest: +SKIP
+        True
+        >>> pd.Series([False]).item()  # doctest: +SKIP
+        False
         """
 
         warnings.warn(