summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorEric Hunsberger <erichuns@gmail.com>2014-11-20 22:09:54 -0500
committerEric Hunsberger <erichuns@gmail.com>2014-11-20 22:09:54 -0500
commitb63b64eb8d7b0236d77e44e1705e622d15f30daa (patch)
treeda9ccc5cdd341e76b895feb1f6832678a54c02ef /numpy/add_newdocs.py
parent31b94e85a99db998bd6156d2b800386973fef3e1 (diff)
downloadnumpy-b63b64eb8d7b0236d77e44e1705e622d15f30daa.tar.gz
DOC: array docstring lists correct order default
Fixes #5306
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index a88a782b4..457c04803 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -664,13 +664,13 @@ add_newdoc('numpy.core.multiarray', 'array',
nested sequence, or if a copy is needed to satisfy any of the other
requirements (`dtype`, `order`, etc.).
order : {'C', 'F', 'A'}, optional
- Specify the order of the array. If order is 'C' (default), then the
- array will be in C-contiguous order (last-index varies the
- fastest). If order is 'F', then the returned array
- will be in Fortran-contiguous order (first-index varies the
- fastest). If order is 'A', then the returned array may
- be in any order (either C-, Fortran-contiguous, or even
- discontiguous).
+ Specify the order of the array. If order is 'C', then the array
+ will be in C-contiguous order (last-index varies the fastest).
+ If order is 'F', then the returned array will be in
+ Fortran-contiguous order (first-index varies the fastest).
+ If order is 'A' (default), then the returned array may be
+ in any order (either C-, Fortran-contiguous, or even discontiguous),
+ unless a copy is required, in which case it will be C-contiguous.
subok : bool, optional
If True, then sub-classes will be passed-through, otherwise
the returned array will be forced to be a base-class array (default).