diff options
author | Jesus Cea <jcea@jcea.es> | 2014-06-25 03:37:17 (GMT) |
---|---|---|
committer | Jesus Cea <jcea@jcea.es> | 2014-06-25 03:37:17 (GMT) |
commit | e8ef8b7a2095fdca3c16c1166b9c071dede55e22 (patch) | |
tree | aea8494323a4d7ec5dead4a70503d50f39d129bc /Doc/c-api/buffer.rst | |
parent | 0fd3972a3f8f9fcb9cecd30a608eea02d6b3b18e (diff) | |
download | cpython-e8ef8b7a2095fdca3c16c1166b9c071dede55e22.zip cpython-e8ef8b7a2095fdca3c16c1166b9c071dede55e22.tar.gz cpython-e8ef8b7a2095fdca3c16c1166b9c071dede55e22.tar.bz2 |
Closes #21441: Reorder elements in documentation to match actual order in the code
Diffstat (limited to 'Doc/c-api/buffer.rst')
-rw-r--r-- | Doc/c-api/buffer.rst | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst index f703e9c..a7de37e 100644 --- a/Doc/c-api/buffer.rst +++ b/Doc/c-api/buffer.rst @@ -89,6 +89,16 @@ a buffer, see :c:func:`PyObject_GetBuffer`. .. c:type:: Py_buffer + .. c:member:: void \*buf + + A pointer to the start of the logical structure described by the buffer + fields. This can be any location within the underlying physical memory + block of the exporter. For example, with negative :c:member:`~Py_buffer.strides` + the value may point to the end of the memory block. + + For contiguous arrays, the value points to the beginning of the memory + block. + .. c:member:: void \*obj A new reference to the exporting object. The reference is owned by @@ -101,16 +111,6 @@ a buffer, see :c:func:`PyObject_GetBuffer`. this field is *NULL*. In general, exporting objects MUST NOT use this scheme. - .. c:member:: void \*buf - - A pointer to the start of the logical structure described by the buffer - fields. This can be any location within the underlying physical memory - block of the exporter. For example, with negative :c:member:`~Py_buffer.strides` - the value may point to the end of the memory block. - - For contiguous arrays, the value points to the beginning of the memory - block. - .. c:member:: Py_ssize_t len ``product(shape) * itemsize``. For contiguous arrays, this is the length |