diff options
| author | Thomas A Caswell <tcaswell@gmail.com> | 2014-12-09 14:39:48 -0500 |
|---|---|---|
| committer | Julian Taylor <jtaylor.debian@googlemail.com> | 2014-12-10 19:55:20 +0100 |
| commit | 14a3dca63e7fac58a1311acf3e01ab548a2e7ea2 (patch) | |
| tree | 5b19867ddf62e4a3e3f453270e7d1d7643236815 /numpy/core/function_base.py | |
| parent | b40e686f10421099400a533b343d6d1212f786e9 (diff) | |
| download | numpy-14a3dca63e7fac58a1311acf3e01ab548a2e7ea2.tar.gz | |
DOC : minor changes to linspace docstring
- added optional flag to dtype
- moved conditional on step to the description from the type
Diffstat (limited to 'numpy/core/function_base.py')
| -rw-r--r-- | numpy/core/function_base.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/numpy/core/function_base.py b/numpy/core/function_base.py index 400e75eb5..4b58d660b 100644 --- a/numpy/core/function_base.py +++ b/numpy/core/function_base.py @@ -32,7 +32,7 @@ def linspace(start, stop, num=50, endpoint=True, retstep=False, dtype=None): retstep : bool, optional If True, return (`samples`, `step`), where `step` is the spacing between samples. - dtype : dtype + dtype : dtype, optional The type of the output array. If `dtype` is not given, infer the data type from the other input arguments. @@ -42,7 +42,9 @@ def linspace(start, stop, num=50, endpoint=True, retstep=False, dtype=None): There are `num` equally spaced samples in the closed interval ``[start, stop]`` or the half-open interval ``[start, stop)`` (depending on whether `endpoint` is True or False). - step : float (only if `retstep` is True) + step : float + Only returned if `retstep` is True + Size of spacing between samples. |