diff options
| author | Allan Haldane <allan.haldane@gmail.com> | 2015-01-16 23:53:41 -0500 |
|---|---|---|
| committer | Allan Haldane <allan.haldane@gmail.com> | 2015-01-22 17:36:43 -0500 |
| commit | 1bd0b4e8f176cd80e81b5f50832db5f8ba1ee1e9 (patch) | |
| tree | fce876400e049c7927cfe4b62ee4d1ca00a8ed7b /doc/source/user | |
| parent | b69035e8ea28bd759b929822aaba544d3c5f8c30 (diff) | |
| download | numpy-1bd0b4e8f176cd80e81b5f50832db5f8ba1ee1e9.tar.gz | |
DOC: improve record/structured array nomenclature & guide
This update adds a section better describing record arrays in the user
guide (numpy/doc/structured_arrays.py).
It also corrects nomenclature, such that "structured array" refers to
ndarrays with structured dtype, "record array" refers to modified
ndarrays as created by np.rec.array, and "recarray" refers to ndarrays
viewed as np.recarray. See the note at the end of the structured
array user guide.
Diffstat (limited to 'doc/source/user')
| -rw-r--r-- | doc/source/user/basics.rec.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/source/user/basics.rec.rst b/doc/source/user/basics.rec.rst index ce6c3b851..1be5af081 100644 --- a/doc/source/user/basics.rec.rst +++ b/doc/source/user/basics.rec.rst @@ -1,7 +1,7 @@ .. _structured_arrays: -*************************************** -Structured arrays (aka "Record arrays") -*************************************** +***************** +Structured arrays +***************** .. automodule:: numpy.doc.structured_arrays |