diff options
| author | Nelle Varoquaux <nelle.varoquaux@gmail.com> | 2018-02-28 16:38:55 -0800 |
|---|---|---|
| committer | Nelle Varoquaux <nelle.varoquaux@gmail.com> | 2018-03-01 09:20:21 -0800 |
| commit | 5a238789894a1f21961217eaaae3e18bcf6ea7c7 (patch) | |
| tree | 1727145d88a28fa26246ac5f01b4d5a1b0058a43 /numpy/add_newdocs.py | |
| parent | c7459dd7a889193685ce4bfb7028dcf2f73c2703 (diff) | |
| download | numpy-5a238789894a1f21961217eaaae3e18bcf6ea7c7.tar.gz | |
DOC zeros, empty, and ones now have consistent docstrings
closes #10611
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 9740292bb..38da1f0b3 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -845,10 +845,11 @@ add_newdoc('numpy.core.multiarray', 'empty', Parameters ---------- shape : int or tuple of int - Shape of the empty array + Shape of the empty array, e.g., ``(2, 3)`` or ``2``. dtype : data-type, optional - Desired output data-type. - order : {'C', 'F'}, optional + Desired output data-type for the array, e.g, `numpy.int8`. Default is + `numpy.float64`. + order : {'C', 'F'}, optional, default: 'C' Whether to store multi-dimensional data in row-major (C-style) or column-major (Fortran-style) order in memory. @@ -965,14 +966,15 @@ add_newdoc('numpy.core.multiarray', 'zeros', Parameters ---------- - shape : int or sequence of ints + shape : int or tuple of ints Shape of the new array, e.g., ``(2, 3)`` or ``2``. dtype : data-type, optional The desired data-type for the array, e.g., `numpy.int8`. Default is `numpy.float64`. - order : {'C', 'F'}, optional - Whether to store multidimensional data in C- or Fortran-contiguous - (row- or column-wise) order in memory. + order : {'C', 'F'}, optional, default: 'C' + Whether to store multi-dimensional data in row-major + (C-style) or column-major (Fortran-style) order in + memory. Returns ------- |