DOC: improve warnings for Series.{real,imag} (pandas-dev#27651)

jorisvandenbossche · Jul 30, 2019 · be1a43c · be1a43c
1 parent 1125126
commit be1a43c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/doc/source/whatsnew/v0.25.1.rst b/doc/source/whatsnew/v0.25.1.rst
@@ -64,7 +64,7 @@ Numeric
 Conversion
 ^^^^^^^^^^
 
--
+- Improved the warnings for the deprecated methods :meth:`Series.real` and :meth:`Series.imag` (:issue:`27610`)
 -
 -
 

diff --git a/pandas/core/series.py b/pandas/core/series.py
@@ -958,7 +958,9 @@ def real(self):
         .. deprecated 0.25.0
         """
         warnings.warn(
-            "`real` has be deprecated and will be removed in a " "future verison",
+            "`real` is deprecated and will be removed in a future version. "
+            "To eliminate this warning for a Series `ser`, use "
+            "`np.real(ser.to_numpy())` or `ser.to_numpy().real`.",
             FutureWarning,
             stacklevel=2,
         )
@@ -976,7 +978,9 @@ def imag(self):
         .. deprecated 0.25.0
         """
         warnings.warn(
-            "`imag` has be deprecated and will be removed in a " "future verison",
+            "`imag` is deprecated and will be removed in a future version. "
+            "To eliminate this warning for a Series `ser`, use "
+            "`np.imag(ser.to_numpy())` or `ser.to_numpy().imag`.",
             FutureWarning,
             stacklevel=2,
         )
-Original file line number
+Diff line change
@@ Expand Up / @@ -64,7 +64,7 @@ Numeric @@
     Conversion
     ^^^^^^^^^^
-    -
+    - Improved the warnings for the deprecated methods :meth:`Series.real` and :meth:`Series.imag` (:issue:`27610`)
     -
     -
@@ Expand Down @@