summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-01-26 16:48:42 -0500
committerCharles Harris <charlesr.harris@gmail.com>2015-01-26 16:48:42 -0500
commita786c82c312eb7baf8c2879180eb1345f79d8c89 (patch)
treefb2f9812ec8c7eb61531aac84ce6475495c0d02e /numpy/add_newdocs.py
parent2864715a88cc0646f432024d0d21a1e10dde9ada (diff)
parentb63b64eb8d7b0236d77e44e1705e622d15f30daa (diff)
downloadnumpy-a786c82c312eb7baf8c2879180eb1345f79d8c89.tar.gz
Merge pull request #5307 from hunse/array-docstring
Array docstring now lists correct order default
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 68af61ff6..7dd8c5649 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).