From 0dc4e153a2dee0d8e4ea06f8d2cf8de7c89cb7d5 Mon Sep 17 00:00:00 2001 From: Stefan Krah Date: Sun, 1 Feb 2015 19:42:12 +0100 Subject: [PATCH] Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets are required. --- Doc/c-api/buffer.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst index 230c6a957f3..9cfd1528228 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.