summaryrefslogtreecommitdiff
path: root/numpy/ma/core.py
diff options
context:
space:
mode:
authorChiara Marmo <marmochiaskl@gmail.com>2022-10-17 14:52:35 -1000
committerChiara Marmo <marmochiaskl@gmail.com>2022-10-17 14:52:35 -1000
commit38fe698843d8d13fcdbcdce13b186aa66623a324 (patch)
tree15603d6fbda55703c2436d08fc30a336dd4e9479 /numpy/ma/core.py
parent7a85f04e06d87440fe9a33f95eea2860917ddbbc (diff)
downloadnumpy-38fe698843d8d13fcdbcdce13b186aa66623a324.tar.gz
Address reviewer comment.
Diffstat (limited to 'numpy/ma/core.py')
-rw-r--r--numpy/ma/core.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/ma/core.py b/numpy/ma/core.py
index 0eca798de..47323fb99 100644
--- a/numpy/ma/core.py
+++ b/numpy/ma/core.py
@@ -2081,12 +2081,14 @@ def masked_equal(x, value, copy=True):
"""
Mask an array where equal to a given value.
+ Return a MaskedArray, masked where the data in array `x` are
+ equal to `value`. The fill_value of the returned MaskedArray
+ is set to `value`.
+
This function is a shortcut to ``masked_where``, with
`condition` = (x == value). For floating point arrays,
consider using ``masked_values(x, value)``.
- The fill_value is set to `value`.
-
See Also
--------
masked_where : Mask where a condition is met.