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 /numpy/lib/npyio.py | |
| 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 'numpy/lib/npyio.py')
| -rw-r--r-- | numpy/lib/npyio.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py index 5f274f27c..bedd0e941 100644 --- a/numpy/lib/npyio.py +++ b/numpy/lib/npyio.py @@ -656,7 +656,7 @@ def loadtxt(fname, dtype=float, comments='#', delimiter=None, generators should return byte strings for Python 3k. dtype : data-type, optional Data-type of the resulting array; default: float. If this is a - record data-type, the resulting array will be 1-dimensional, and + structured data-type, the resulting array will be 1-dimensional, and each row will be interpreted as an element of the array. In this case, the number of columns used must match the number of fields in the data-type. @@ -680,7 +680,7 @@ def loadtxt(fname, dtype=float, comments='#', delimiter=None, The default, None, results in all columns being read. unpack : bool, optional If True, the returned array is transposed, so that arguments may be - unpacked using ``x, y, z = loadtxt(...)``. When used with a record + unpacked using ``x, y, z = loadtxt(...)``. When used with a structured data-type, arrays are returned for each field. Default is False. ndmin : int, optional The returned array will have at least `ndmin` dimensions. |