From 3f1ef5b756e96486ca4155eb96485e405720d107 Mon Sep 17 00:00:00 2001 From: Stefan Krah Date: Sun, 1 Feb 2015 19:40:50 +0100 Subject: Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets are required. --- Doc/c-api/buffer.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst index 74693ac..7df9c33 100644 --- a/Doc/c-api/buffer.rst +++ b/Doc/c-api/buffer.rst @@ -98,8 +98,11 @@ The new-style Py_buffer struct suboffset value that it negative 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). + Here is a function that returns a pointer to the element in an N-D array - pointed to by an N-dimesional index when there are both non-NULL strides + pointed to by an N-dimensional index when there are both non-NULL strides and suboffsets:: void *get_item_pointer(int ndim, void *buf, Py_ssize_t *strides, -- cgit v0.12