From: Stefan Krah <skrah@bytereef.org>
Date: Sun, 1 Feb 2015 18:40:50 +0000 (+0100)
Subject: Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3f1ef5b756e96486ca4155eb96485e405720d107;p=python

Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets
are required.
---

diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 74693ac584..7df9c33883 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,