diff options
| author | Stefan Krah <skrah@bytereef.org> | 2015-02-01 18:42:12 (GMT) |
|---|---|---|
| committer | Stefan Krah <skrah@bytereef.org> | 2015-02-01 18:42:12 (GMT) |
| commit | 0dc4e153a2dee0d8e4ea06f8d2cf8de7c89cb7d5 (patch) | |
| tree | 43ca439483f15ac7908da543ad63dc8dff5af57d /Doc/c-api/buffer.rst | |
| parent | 7213fcc27ec4ca06fbda4633aff95d8ca2701e43 (diff) | |
| download | cpython-0dc4e153a2dee0d8e4ea06f8d2cf8de7c89cb7d5.zip cpython-0dc4e153a2dee0d8e4ea06f8d2cf8de7c89cb7d5.tar.gz cpython-0dc4e153a2dee0d8e4ea06f8d2cf8de7c89cb7d5.tar.bz2 | |
Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets
are required.
Diffstat (limited to 'Doc/c-api/buffer.rst')
| -rw-r--r-- | Doc/c-api/buffer.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst index 230c6a9..9cfd152 100644 --- a/Doc/c-api/buffer.rst +++ b/Doc/c-api/buffer.rst @@ -198,6 +198,9 @@ a buffer, see :c:func:`PyObject_GetBuffer`. indicates that no de-referencing should occur (striding in a contiguous memory block). + If all suboffsets are negative (i.e. no de-referencing is needed, then + this field must be NULL (the default value). + This type of array representation is used by the Python Imaging Library (PIL). See `complex arrays`_ for further information how to access elements of such an array. |