summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorArun <arun.palaniappan1999@gmail.com>2021-09-20 18:46:08 +0530
committerArun <arun.palaniappan1999@gmail.com>2021-09-20 18:46:08 +0530
commit0f2453eeae6092459296fa3af50a9dff4d9af02b (patch)
tree55860d4c05ab004eb268ec47a67c338ac619c6f1 /numpy
parentdf0b1bd75f0e8489912863d1f9dfde1846a7bf51 (diff)
downloadnumpy-0f2453eeae6092459296fa3af50a9dff4d9af02b.tar.gz
DOC: replace return type in np.ma* docstring
Diffstat (limited to 'numpy')
-rw-r--r--numpy/ma/core.py40
1 files changed, 34 insertions, 6 deletions
diff --git a/numpy/ma/core.py b/numpy/ma/core.py
index b2ac383a2..b4c73c7c7 100644
--- a/numpy/ma/core.py
+++ b/numpy/ma/core.py
@@ -8159,8 +8159,18 @@ arange = _convert2ma(
np_ret='arange : ndarray',
np_ma_ret='arange : MaskedArray',
)
-clip = np.clip
-diff = np.diff
+clip = _convert2ma(
+ 'clip',
+ params=dict(fill_value=None, hardmask=False),
+ np_ret='clipped_array : ndarray',
+ np_ma_ret='clipped_array : MaskedArray',
+)
+diff = _convert2ma(
+ 'diff',
+ params=dict(fill_value=None, hardmask=False),
+ np_ret='diff : ndarray',
+ np_ma_ret='diff : MaskedArray',
+)
empty = _convert2ma(
'empty',
params=dict(fill_value=None, hardmask=False),
@@ -8188,22 +8198,40 @@ identity = _convert2ma(
np_ret='out : ndarray',
np_ma_ret='out : MaskedArray',
)
-indices = np.indices
+indices = _convert2ma(
+ 'indices',
+ params=dict(fill_value=None, hardmask=False),
+ np_ret='grid : one ndarray or tuple of ndarrays',
+ np_ma_ret='grid : one MaskedArray or tuple of MaskedArrays',
+)
ones = _convert2ma(
'ones',
params=dict(fill_value=None, hardmask=False),
np_ret='out : ndarray',
np_ma_ret='out : MaskedArray',
)
-ones_like = np.ones_like
-squeeze = np.squeeze
+ones_like = _convert2ma(
+ 'ones_like',
+ np_ret='out : ndarray',
+ np_ma_ret='out : MaskedArray',
+)
+squeeze = _convert2ma(
+ 'squeeze',
+ params=dict(fill_value=None, hardmask=False),
+ np_ret='squeezed : ndarray',
+ np_ma_ret='squeezed : MaskedArray',
+)
zeros = _convert2ma(
'zeros',
params=dict(fill_value=None, hardmask=False),
np_ret='out : ndarray',
np_ma_ret='out : MaskedArray',
)
-zeros_like = np.zeros_like
+zeros_like = _convert2ma(
+ 'zeros_like',
+ np_ret='out : ndarray',
+ np_ma_ret='out : MaskedArray',
+)
def append(a, b, axis=None):