]> granicus.if.org Git - python/commitdiff
Issue #23352: Document that Py_buffer.suboffsets must be NULL if no suboffsets
authorStefan Krah <skrah@bytereef.org>
Sun, 1 Feb 2015 18:40:50 +0000 (19:40 +0100)
committerStefan Krah <skrah@bytereef.org>
Sun, 1 Feb 2015 18:40:50 +0000 (19:40 +0100)
are required.

Doc/c-api/buffer.rst

index 74693ac58471ef9432ecd832f5395ecea75e3100..7df9c338833e8e6b447454cfb5ca5fa99bc24ad1 100644 (file)
@@ -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,