summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorHong Xu <hong@topbug.net>2017-09-16 00:54:29 -0700
committerHong Xu <hong@topbug.net>2017-09-16 21:02:12 -0700
commite67ff5a12fb1a00140486bf1a5ae9a39fbcbdadd (patch)
tree810b6dacb5aedb21c0beb48872ab0b5b5d0ab7f4 /numpy/add_newdocs.py
parent7da52beb00b7c5d44ed1c946f2b43692d6ec4e1a (diff)
downloadnumpy-e67ff5a12fb1a00140486bf1a5ae9a39fbcbdadd.tar.gz
arange: `start` is not needed even when `step` is given.
The documentation says `start` must be given if `step` is specified, but this is not true. For example, arange(5, step=2) works.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 477a3db34..8c23e1441 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -1338,7 +1338,8 @@ add_newdoc('numpy.core.multiarray', 'arange',
step : number, 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, `start` must also be given.
+ step size is 1. If `step` is specified as a position argument,
+ `start` must also be given.
dtype : dtype
The type of the output array. If `dtype` is not given, infer the data
type from the other input arguments.