summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Nathanson <github@bigriver.xyz>2020-06-12 16:59:08 -0400
committerBen Nathanson <github@bigriver.xyz>2020-06-12 16:59:08 -0400
commit0994b5af8b790cda7fda0002bae3c269f8317e74 (patch)
tree7df0cc7831e43a9cf06d5657ab94db522882d342
parent5345c2575a28fa2dfbbec83c99636669476c2745 (diff)
downloadnumpy-0994b5af8b790cda7fda0002bae3c269f8317e74.tar.gz
DOC: Disallow complex args in arange
As noted in issue #10332, arange with complex start, stop, or step returns an empty array. Until the code is changed, specify that these args can only be integer or real.
-rw-r--r--numpy/core/_add_newdocs.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/numpy/core/_add_newdocs.py b/numpy/core/_add_newdocs.py
index d0ed3d381..33c1f08b1 100644
--- a/numpy/core/_add_newdocs.py
+++ b/numpy/core/_add_newdocs.py
@@ -1307,14 +1307,14 @@ add_newdoc('numpy.core.multiarray', 'arange',
Parameters
----------
- start : number, optional
+ start : integer or real, optional
Start of interval. The interval includes this value. The default
start value is 0.
- stop : number
+ stop : integer or real
End of interval. The interval does not include this value, except
in some cases where `step` is not an integer and floating point
round-off affects the length of `out`.
- step : number, optional
+ step : integer or real, optional
Spacing between values. For any output `out`, this is the distance
between two adjacent values, ``out[i+1] - out[i]``. The default
step size is 1. If `step` is specified as a position argument,