diff options
author | seberg <sebastian@sipsolutions.net> | 2015-12-18 13:21:03 +0100 |
---|---|---|
committer | seberg <sebastian@sipsolutions.net> | 2015-12-18 13:21:03 +0100 |
commit | 3af5f0574740611076df9dc905330defab70a6dc (patch) | |
tree | 918a324b3ffb9b1abff63ee7c35d668783667cbc /numpy/add_newdocs.py | |
parent | f7b07521ca811baa2fcc649a6dc5cf56f5c65fd0 (diff) | |
parent | 088e20e272389395fb3fd24fed144ed19bae8cdb (diff) | |
download | numpy-3af5f0574740611076df9dc905330defab70a6dc.tar.gz |
Merge pull request #6823 from gfyoung/order_arg_validate
Stricter Argument Checking for Flatten Methods
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r-- | numpy/add_newdocs.py | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index c14036089..01ef24a5b 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -3567,10 +3567,14 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('flatten', Parameters ---------- - order : {'C', 'F', 'A'}, optional - Whether to flatten in row-major (C-style) or - column-major (Fortran-style) order or preserve the - C/Fortran ordering from `a`. The default is 'C'. + order : {'C', 'F', 'A', 'K'}, optional + 'C' means to flatten in row-major (C-style) order. + 'F' means to flatten in column-major (Fortran- + style) order. 'A' means to flatten in column-major + order if `a` is Fortran *contiguous* in memory, + row-major order otherwise. 'K' means to flatten + `a` in the order the elements occur in memory. + The default is 'C'. Returns ------- |