diff options
Diffstat (limited to 'doc/source/reference')
| -rw-r--r-- | doc/source/reference/arrays.interface.rst | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/source/reference/arrays.interface.rst b/doc/source/reference/arrays.interface.rst index 2f843d2af..904d0132b 100644 --- a/doc/source/reference/arrays.interface.rst +++ b/doc/source/reference/arrays.interface.rst @@ -125,11 +125,15 @@ This approach to the interface consists of the object having an **Default**: ``[('', typestr)]`` **data** (optional) - A 2-tuple whose first argument is a signed integer (capable of - holding a pointer to ``void`` such as the C/C++ type - `intptr_t <https://en.cppreference.com/w/cpp/types/integer>`__) - that points to the data-area storing the array - contents. This pointer must point to the first element of + A 2-tuple whose first argument is a :doc:`Python integer <c-api/long>` + that points to the data-area storing the array contents. + + .. note:: + When converting from C/C++ via ``PyLong_From*`` or high-level + bindings such as Cython or pybind11, make sure to use an integer + of sufficiently large bitness. + + This pointer must point to the first element of data (in other words any offset is always ignored in this case). The second entry in the tuple is a read-only flag (true means the data area is read-only). |