diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2020-09-30 12:03:36 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-30 12:03:36 -0600 |
| commit | ed7d967ff37b649a3b5ce8adc51cdf4ec9dd39a3 (patch) | |
| tree | 1ecf0a6428c5919175f5b61614f66eddf4735e6f | |
| parent | 60945085cfd1abf4e04db461040bc675f1d325c7 (diff) | |
| parent | 3599af53d7fbf3976020b8443424ed5ffb955693 (diff) | |
| download | numpy-ed7d967ff37b649a3b5ce8adc51cdf4ec9dd39a3.tar.gz | |
Merge pull request #17400 from rossbar/doc/correct_rec_alias
DOC: rm incorrect alias from recarray user article.
| -rw-r--r-- | doc/source/user/basics.rec.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/source/user/basics.rec.rst b/doc/source/user/basics.rec.rst index f579b0d85..bb4ed89e9 100644 --- a/doc/source/user/basics.rec.rst +++ b/doc/source/user/basics.rec.rst @@ -575,11 +575,14 @@ Record Arrays ============= As an optional convenience numpy provides an ndarray subclass, -:class:`numpy.recarray`, and associated helper functions in the -:mod:`numpy.lib.recfunctions` submodule (aliased as ``numpy.rec``), that allows -access to fields of structured arrays by attribute instead of only by index. -Record arrays also use a special datatype, :class:`numpy.record`, that allows +:class:`numpy.recarray` that allows access to fields of structured arrays by +attribute instead of only by index. +Record arrays use a special datatype, :class:`numpy.record`, that allows field access by attribute on the structured scalars obtained from the array. +The :mod:`numpy.rec` module provides functions for creating recarrays from +various objects. +Additional helper functions for creating and manipulating structured arrays +can be found in :mod:`numpy.lib.recfunctions`. The simplest way to create a record array is with ``numpy.rec.array``:: |