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 /doc | |
| 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 'doc')
| -rw-r--r-- | doc/release/1.11.0-notes.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/release/1.11.0-notes.rst b/doc/release/1.11.0-notes.rst index b3ddae604..7c078eed9 100644 --- a/doc/release/1.11.0-notes.rst +++ b/doc/release/1.11.0-notes.rst @@ -133,3 +133,11 @@ c_contiguous arrays at some future time. A work around that is backward compatible is to use `a.T.view(...).T` instead. A parameter will also be added to the view method to explicitly ask for Fortran order views, but that will not be backward compatible. + +Invalid arguments for array ordering +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +It is currently possible to pass in arguments for the ```order``` +parameter in methods like ```array.flatten``` or ```array.ravel``` +that were not one of the following: 'C', 'F', 'A', 'K' (note that +all of these possible values are unicode- and case-insensitive). +Such behaviour will not be allowed in future releases. |