diff options
author | Allan Haldane <allan.haldane@gmail.com> | 2018-12-15 11:46:22 -0500 |
---|---|---|
committer | Allan Haldane <allan.haldane@gmail.com> | 2018-12-15 11:47:03 -0500 |
commit | 2981ed622501ac48c54c4efdf06a84084b70ff66 (patch) | |
tree | 2f4cea4c0abdcb1704d56d7746232138af057e81 /doc/source/reference/arrays.indexing.rst | |
parent | e26c2990c4828d6f7f2f588d75cd01eecafd53f3 (diff) | |
download | numpy-2981ed622501ac48c54c4efdf06a84084b70ff66.tar.gz |
DOC: more doc updates for structured arrays
[ci skip]
Diffstat (limited to 'doc/source/reference/arrays.indexing.rst')
-rw-r--r-- | doc/source/reference/arrays.indexing.rst | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/doc/source/reference/arrays.indexing.rst b/doc/source/reference/arrays.indexing.rst index 5f67a788a..3a319ecca 100644 --- a/doc/source/reference/arrays.indexing.rst +++ b/doc/source/reference/arrays.indexing.rst @@ -514,14 +514,10 @@ only the part of the data in the specified field. Also :ref:`record array <arrays.classes.rec>` scalars can be "indexed" this way. Indexing into a structured array can also be done with a list of field names, -*e.g.* ``x[['field-name1','field-name2']]``. Currently this returns a new -array containing a copy of the values in the fields specified in the list. -As of NumPy 1.7, returning a copy is being deprecated in favor of returning -a view. A copy will continue to be returned for now, but a FutureWarning -will be issued when writing to the copy. If you depend on the current -behavior, then we suggest copying the returned array explicitly, i.e. use -x[['field-name1','field-name2']].copy(). This will work with both past and -future versions of NumPy. +*e.g.* ``x[['field-name1','field-name2']]``. As of NumPy 1.16 this returns a +view containing only those fields. In older versions of numpy it returned a +copy. See the user guide section on :ref:`structured_arrays` for more +information on multifield indexing. If the accessed field is a sub-array, the dimensions of the sub-array are appended to the shape of the result. |