summaryrefslogtreecommitdiff
path: root/numpy/ma/extras.py
diff options
context:
space:
mode:
authorPax <13646646+paxcodes@users.noreply.github.com>2022-03-26 12:34:04 -0700
committerGitHub <noreply@github.com>2022-03-26 12:34:04 -0700
commit119bf865b15747bea815ec3ced10e2bbc1ba8de1 (patch)
tree38753e7fe4a63193e4330b96902851085e3a93fb /numpy/ma/extras.py
parent72b1203d4b4979e52a14e7bc3cd42704f69ead12 (diff)
downloadnumpy-119bf865b15747bea815ec3ced10e2bbc1ba8de1.tar.gz
DOC: fix data type of parameter shape (#21251)
`np.ma.masked_all` uses `np.empty` under the hood, so the parameter description for shape in `masked_all` should be updated to match that of `np.empty`. Relevant issue: #21203
Diffstat (limited to 'numpy/ma/extras.py')
-rw-r--r--numpy/ma/extras.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/ma/extras.py b/numpy/ma/extras.py
index 7f3e25900..048d94bb7 100644
--- a/numpy/ma/extras.py
+++ b/numpy/ma/extras.py
@@ -110,8 +110,8 @@ def masked_all(shape, dtype=float):
Parameters
----------
- shape : tuple
- Shape of the required MaskedArray.
+ shape : int or tuple of ints
+ Shape of the required MaskedArray, e.g., ``(2, 3)`` or ``2``.
dtype : dtype, optional
Data type of the output.