Merge pull request #6920 from gfyoung/filled_documentation

charris · charris · commit 2fb2b66aa459 · 2016-01-04T07:38:23.000-07:00
DOC: Fix documentation on MaskedArray.filled
diff --git a/numpy/ma/core.py b/numpy/ma/core.py
@@ -3526,6 +3526,8 @@ def set_fill_value(self, value=None):
     def filled(self, fill_value=None):
         """
         Return a copy of self, with masked values filled with a given value.
+        **However**, if there are no masked values to fill, self will be
+        returned instead as an ndarray.
 
         Parameters
         ----------
@@ -3537,7 +3539,9 @@ def filled(self, fill_value=None):
         -------
         filled_array : ndarray
             A copy of ``self`` with invalid entries replaced by *fill_value*
-            (be it the function argument or the attribute of ``self``.
+            (be it the function argument or the attribute of ``self``), or
+            ``self`` itself as an ndarray if there are no invalid entries to
+            be replaced.
 
         Notes
         -----
