diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2015-07-01 23:36:38 -0600 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2015-07-01 23:40:56 -0600 |
| commit | f5e9adbbf87903e42d03bb3dd5f86b70a89e930c (patch) | |
| tree | d35f5116d0ce8c579b583cda4a3ee32c541fb6bd /numpy/add_newdocs.py | |
| parent | f940a9e434e2ba39328361336711502895a42194 (diff) | |
| download | numpy-f5e9adbbf87903e42d03bb3dd5f86b70a89e930c.tar.gz | |
DOC: Fix docstring warnings in documetation generation.
Most of these fixes involve putting blank lines around
.. versionadded:: x.x.x
and
.. deprecated:: x.x.x
Some of the examples were also fixed.
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index be32d0cfa..a6d7dc32e 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -790,14 +790,16 @@ add_newdoc('numpy.core.multiarray', 'empty_like', The shape and data-type of `a` define these same attributes of the returned array. dtype : data-type, optional - .. versionadded:: 1.6.0 Overrides the data type of the result. - order : {'C', 'F', 'A', or 'K'}, optional + .. versionadded:: 1.6.0 + order : {'C', 'F', 'A', or 'K'}, optional Overrides the memory layout of the result. 'C' means C-order, 'F' means F-order, 'A' means 'F' if ``a`` is Fortran contiguous, 'C' otherwise. 'K' means match the layout of ``a`` as closely as possible. + + .. versionadded:: 1.6.0 subok : bool, optional. If True, then the newly created array will use the sub-class type of 'a', otherwise it will be a base-class array. Defaults @@ -1703,6 +1705,7 @@ add_newdoc('numpy.core.multiarray', 'promote_types', Notes ----- .. versionadded:: 1.6.0 + Starting in NumPy 1.9, promote_types function now returns a valid string length when given an integer or float dtype as one argument and a string dtype as another argument. Previously it always returned the input string @@ -5039,10 +5042,10 @@ add_newdoc('numpy.core.multiarray', 'bincount', weights : array_like, optional Weights, array of the same shape as `x`. minlength : int, optional - .. versionadded:: 1.6.0 - A minimum number of bins for the output array. + .. versionadded:: 1.6.0 + Returns ------- out : ndarray of ints @@ -5164,10 +5167,11 @@ add_newdoc('numpy.core.multiarray', 'unravel_index', dims : tuple of ints The shape of the array to use for unraveling ``indices``. order : {'C', 'F'}, optional - .. versionadded:: 1.6.0 Determines whether the indices should be viewed as indexing in row-major (C-style) or column-major (Fortran-style) order. + .. versionadded:: 1.6.0 + Returns ------- unraveled_coords : tuple of ndarray |