summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2015-08-18 06:38:34 (GMT)
committerBenjamin Peterson <benjamin@python.org>2015-08-18 06:38:34 (GMT)
commit2053aa119318c6bc931fff1cd76c1ab624e49232 (patch)
tree7c31b6bdd9e0c744fc5eddfa1174ddd7b1df4832
parenteca0445733acf31e9b7b38dfdeb7d9f28d2c998f (diff)
downloadcpython-2053aa119318c6bc931fff1cd76c1ab624e49232.zip
cpython-2053aa119318c6bc931fff1cd76c1ab624e49232.tar.gz
cpython-2053aa119318c6bc931fff1cd76c1ab624e49232.tar.bz2
'Py_Buffer' should be 'Py_buffer' (closes #24883)
-rw-r--r--Doc/c-api/buffer.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index e6330e7..d099ace 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -133,15 +133,15 @@ a buffer, see :c:func:`PyObject_GetBuffer`.
called on non-NULL :c:member:`~Py_buffer.format` values.
Important exception: If a consumer requests a buffer without the
- :c:macro:`PyBUF_FORMAT` flag, :c:member:`~Py_Buffer.format` will
+ :c:macro:`PyBUF_FORMAT` flag, :c:member:`~Py_buffer.format` will
be set to *NULL*, but :c:member:`~Py_buffer.itemsize` still has
the value for the original format.
- If :c:member:`~Py_Buffer.shape` is present, the equality
+ If :c:member:`~Py_buffer.shape` is present, the equality
``product(shape) * itemsize == len`` still holds and the consumer
can use :c:member:`~Py_buffer.itemsize` to navigate the buffer.
- If :c:member:`~Py_Buffer.shape` is *NULL* as a result of a :c:macro:`PyBUF_SIMPLE`
+ If :c:member:`~Py_buffer.shape` is *NULL* as a result of a :c:macro:`PyBUF_SIMPLE`
or a :c:macro:`PyBUF_WRITABLE` request, the consumer must disregard
:c:member:`~Py_buffer.itemsize` and assume ``itemsize == 1``.
@@ -156,7 +156,7 @@ a buffer, see :c:func:`PyObject_GetBuffer`.
.. c:member:: int ndim
The number of dimensions the memory represents as an n-dimensional array.
- If it is 0, :c:member:`~Py_Buffer.buf` points to a single item representing
+ If it is 0, :c:member:`~Py_buffer.buf` points to a single item representing
a scalar. In this case, :c:member:`~Py_buffer.shape`, :c:member:`~Py_buffer.strides`
and :c:member:`~Py_buffer.suboffsets` MUST be *NULL*.