diff options
| author | gfyoung <gfyoung@mit.edu> | 2015-12-11 04:24:16 +0000 |
|---|---|---|
| committer | gfyoung <gfyoung17@gmail.com> | 2015-12-18 03:02:21 -0800 |
| commit | 088e20e272389395fb3fd24fed144ed19bae8cdb (patch) | |
| tree | 918a324b3ffb9b1abff63ee7c35d668783667cbc /numpy/add_newdocs.py | |
| parent | f7b07521ca811baa2fcc649a6dc5cf56f5c65fd0 (diff) | |
| download | numpy-088e20e272389395fb3fd24fed144ed19bae8cdb.tar.gz | |
DEP: Stricter arg checking for array ordering
The bug traces to the PyArray_OrderConverter
method in conversion_utils.c, where no errors
are thrown if the ORDER parameter passed in
is not of the string data-type or has a string
value of length greater than one. This commit
causes a DeprecationWarning to be raised, which
will later be turned into a TypeError or another
type of error in a future release.
Closes gh-6598.
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 ------- |