diff options
| author | Thomas A Caswell <tcaswell@gmail.com> | 2014-12-09 18:19:32 -0500 |
|---|---|---|
| committer | Thomas A Caswell <tcaswell@bnl.gov> | 2014-12-12 14:00:39 -0500 |
| commit | 93ee10ef98936e1fa5386836fd5b34b4b6e4bb68 (patch) | |
| tree | c884b1d3fb8802c8164545246707ed53f7b773f1 /numpy/core | |
| parent | 48b61ec8c4b6e81100d96b3ab854947dd6ab1f64 (diff) | |
| download | numpy-93ee10ef98936e1fa5386836fd5b34b4b6e4bb68.tar.gz | |
DOC : do not abuse enum markup
- {ndarray, bool} -> ndarray or bool
- {int, array of ints} -> int or array of ints
- {str, function} -> str or function
- {sequnce, int} -> sequence or int
- {array_like, poly1d} -> array_like or poly1d
- {None, list of `m` scalars, scalar} -> list of `m` scalars or scalar
Diffstat (limited to 'numpy/core')
| -rw-r--r-- | numpy/core/code_generators/ufunc_docstrings.py | 8 | ||||
| -rw-r--r-- | numpy/core/defchararray.py | 12 | ||||
| -rw-r--r-- | numpy/core/fromnumeric.py | 2 |
3 files changed, 11 insertions, 11 deletions
diff --git a/numpy/core/code_generators/ufunc_docstrings.py b/numpy/core/code_generators/ufunc_docstrings.py index 1cd486608..ce9979d12 100644 --- a/numpy/core/code_generators/ufunc_docstrings.py +++ b/numpy/core/code_generators/ufunc_docstrings.py @@ -999,7 +999,7 @@ add_newdoc('numpy.core.umath', 'equal', Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also @@ -1632,7 +1632,7 @@ add_newdoc('numpy.core.umath', 'isnan', Returns ------- - y : {ndarray, bool} + y : ndarray or bool For scalar input, the result is a new boolean with value True if the input is NaN; otherwise the value is False. @@ -2046,7 +2046,7 @@ add_newdoc('numpy.core.umath', 'logical_and', Returns ------- - y : {ndarray, bool} + y : ndarray or bool Boolean result with the same shape as `x1` and `x2` of the logical AND operation on corresponding elements of `x1` and `x2`. @@ -2112,7 +2112,7 @@ add_newdoc('numpy.core.umath', 'logical_or', Returns ------- - y : {ndarray, bool} + y : ndarray or bool Boolean result with the same shape as `x1` and `x2` of the logical OR operation on elements of `x1` and `x2`. diff --git a/numpy/core/defchararray.py b/numpy/core/defchararray.py index 121e32314..cc6cb5a38 100644 --- a/numpy/core/defchararray.py +++ b/numpy/core/defchararray.py @@ -109,7 +109,7 @@ def equal(x1, x2): Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also @@ -133,7 +133,7 @@ def not_equal(x1, x2): Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also @@ -158,7 +158,7 @@ def greater_equal(x1, x2): Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also @@ -182,7 +182,7 @@ def less_equal(x1, x2): Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also @@ -206,7 +206,7 @@ def greater(x1, x2): Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also @@ -230,7 +230,7 @@ def less(x1, x2): Returns ------- - out : {ndarray, bool} + out : ndarray or bool Output array of bools, or a single bool if x1 and x2 are scalars. See Also diff --git a/numpy/core/fromnumeric.py b/numpy/core/fromnumeric.py index 84a10bf04..9b75255da 100644 --- a/numpy/core/fromnumeric.py +++ b/numpy/core/fromnumeric.py @@ -355,7 +355,7 @@ def repeat(a, repeats, axis=None): ---------- a : array_like Input array. - repeats : {int, array of ints} + repeats : int or array of ints The number of repetitions for each element. `repeats` is broadcasted to fit the shape of the given axis. axis : int, optional |