From 5a238789894a1f21961217eaaae3e18bcf6ea7c7 Mon Sep 17 00:00:00 2001 From: Nelle Varoquaux Date: Wed, 28 Feb 2018 16:38:55 -0800 Subject: [PATCH] DOC zeros, empty, and ones now have consistent docstrings closes #10611 --- numpy/add_newdocs.py | 16 +++++++++------- numpy/core/numeric.py | 7 ++++--- 2 files changed, 13 insertions(+), 10 deletions(-) diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 9740292bbdbe..38da1f0b3e90 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -845,10 +845,11 @@ def luf(lamdaexpr, *args, **kwargs): 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 @@ def luf(lamdaexpr, *args, **kwargs): 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 ------- diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py index d2d59d9b2135..1f249ae6cba2 100644 --- a/numpy/core/numeric.py +++ b/numpy/core/numeric.py @@ -160,9 +160,10 @@ def ones(shape, dtype=None, order='C'): 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 -------