summaryrefslogtreecommitdiff
path: root/numpy/ma/extras.py
diff options
context:
space:
mode:
authorSebastian Berg <sebastian@sipsolutions.net>2019-12-02 14:17:39 -0600
committerGitHub <noreply@github.com>2019-12-02 14:17:39 -0600
commit5992098524c9f36288093ef3298d44343735842e (patch)
treebbcf59bcd293b763841c23f076927c0aa96533d8 /numpy/ma/extras.py
parent7b2d968d5a4730489d9e9148afe2277b1bc32477 (diff)
parent14bcfd9cfe0deb4e6499b398d7eba4d7e3dd7fe8 (diff)
downloadnumpy-5992098524c9f36288093ef3298d44343735842e.tar.gz
Merge pull request #14996 from eric-wieser/masked_rows-bad-argument
DEP: Deprecate the axis argument to masked_rows and masked_cols
Diffstat (limited to 'numpy/ma/extras.py')
-rw-r--r--numpy/ma/extras.py16
1 files changed, 14 insertions, 2 deletions
diff --git a/numpy/ma/extras.py b/numpy/ma/extras.py
index 4a83ac781..f4a914471 100644
--- a/numpy/ma/extras.py
+++ b/numpy/ma/extras.py
@@ -937,7 +937,7 @@ def compress_cols(a):
raise NotImplementedError("compress_cols works for 2D arrays only.")
return compress_rowcols(a, 1)
-def mask_rows(a, axis=None):
+def mask_rows(a, axis=np._NoValue):
"""
Mask rows of a 2D array that contain masked values.
@@ -979,9 +979,15 @@ def mask_rows(a, axis=None):
fill_value=1)
"""
+ if axis is not np._NoValue:
+ # remove the axis argument when this deprecation expires
+ # NumPy 1.18.0, 2019-11-28
+ warnings.warn(
+ "The axis argument has always been ignored, in future passing it "
+ "will raise TypeError", DeprecationWarning, stacklevel=2)
return mask_rowcols(a, 0)
-def mask_cols(a, axis=None):
+def mask_cols(a, axis=np._NoValue):
"""
Mask columns of a 2D array that contain masked values.
@@ -1022,6 +1028,12 @@ def mask_cols(a, axis=None):
fill_value=1)
"""
+ if axis is not np._NoValue:
+ # remove the axis argument when this deprecation expires
+ # NumPy 1.18.0, 2019-11-28
+ warnings.warn(
+ "The axis argument has always been ignored, in future passing it "
+ "will raise TypeError", DeprecationWarning, stacklevel=2)
return mask_rowcols(a, 1)