summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2018-09-09 08:07:26 -0500
committerGitHub <noreply@github.com>2018-09-09 08:07:26 -0500
commit1afd0d47a4ef32c5dbc003006d67b22bbbc73d93 (patch)
treeee66466ed7d0993f040c9a4271f77a957e2e69f7 /doc
parente796449b8dea5f11a959d5664b9a2669add26eed (diff)
parent0346b1b04e3503df25937c239af2a1806e652963 (diff)
downloadnumpy-1afd0d47a4ef32c5dbc003006d67b22bbbc73d93.tar.gz
Merge pull request #11912 from mattip/dtype-offset-int
DOC: dtype offset and itemsize is limited by range of C int
Diffstat (limited to 'doc')
-rw-r--r--doc/source/reference/arrays.dtypes.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/source/reference/arrays.dtypes.rst b/doc/source/reference/arrays.dtypes.rst
index d771f2940..f2072263f 100644
--- a/doc/source/reference/arrays.dtypes.rst
+++ b/doc/source/reference/arrays.dtypes.rst
@@ -391,8 +391,8 @@ Type strings
When the optional keys *offsets* and *titles* are provided,
their values must each be lists of the same length as the *names*
and *formats* lists. The *offsets* value is a list of byte offsets
- (integers) for each field, while the *titles* value is a list of
- titles for each field (:const:`None` can be used if no title is
+ (limited to `ctypes.c_int`) for each field, while the *titles* value is a
+ list of titles for each field (:const:`None` can be used if no title is
desired for that field). The *titles* can be any :class:`string`
or :class:`unicode` object and will add another entry to the
fields dictionary keyed by the title and referencing the same
@@ -402,7 +402,8 @@ Type strings
The *itemsize* key allows the total size of the dtype to be
set, and must be an integer large enough so all the fields
are within the dtype. If the dtype being constructed is aligned,
- the *itemsize* must also be divisible by the struct alignment.
+ the *itemsize* must also be divisible by the struct alignment. Total dtype
+ *itemsize* is limited to `ctypes.c_int`.
.. admonition:: Example