summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-08-16 20:32:17 (GMT)
committerGitHub <noreply@github.com>2023-08-16 20:32:17 (GMT)
commit4e5dac1fe17cd7bbc8dad19e3e33c249a8a203c2 (patch)
tree72e72611386c1b57e9b56e53af17958f30269cd5 /Doc/c-api
parent05ff5fa11d5e082906042ef7b48163c2f0f2c888 (diff)
downloadcpython-4e5dac1fe17cd7bbc8dad19e3e33c249a8a203c2.zip
cpython-4e5dac1fe17cd7bbc8dad19e3e33c249a8a203c2.tar.gz
cpython-4e5dac1fe17cd7bbc8dad19e3e33c249a8a203c2.tar.bz2
[3.11] gh-107298: Fix C API Buffer documentation (GH-108011) (#108041)
gh-107298: Fix C API Buffer documentation (GH-108011) (cherry picked from commit c2941cba7a986e6158eebb2a0bf33906dcd78616) Co-authored-by: Victor Stinner <vstinner@python.org>
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/buffer.rst22
-rw-r--r--Doc/c-api/typeobj.rst2
2 files changed, 14 insertions, 10 deletions
diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index ba391a5..e572815 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -163,13 +163,6 @@ a buffer, see :c:func:`PyObject_GetBuffer`.
and :c:member:`~Py_buffer.suboffsets` MUST be ``NULL``.
The maximum number of dimensions is given by :c:macro:`PyBUF_MAX_NDIM`.
- .. :c:macro:: PyBUF_MAX_NDIM
-
- The maximum number of dimensions the memory represents.
- Exporters MUST respect this limit, consumers of multi-dimensional
- buffers SHOULD be able to handle up to :c:macro:`!PyBUF_MAX_NDIM` dimensions.
- Currently set to 64.
-
.. c:member:: Py_ssize_t *shape
An array of :c:type:`Py_ssize_t` of length :c:member:`~Py_buffer.ndim`
@@ -221,6 +214,17 @@ a buffer, see :c:func:`PyObject_GetBuffer`.
freed when the buffer is released. The consumer MUST NOT alter this
value.
+
+Constants:
+
+.. c:macro:: PyBUF_MAX_NDIM
+
+ The maximum number of dimensions the memory represents.
+ Exporters MUST respect this limit, consumers of multi-dimensional
+ buffers SHOULD be able to handle up to :c:macro:`!PyBUF_MAX_NDIM` dimensions.
+ Currently set to 64.
+
+
.. _buffer-request-types:
Buffer request types
@@ -444,7 +448,7 @@ Buffer-related functions
Send a request to *exporter* to fill in *view* as specified by *flags*.
If the exporter cannot provide a buffer of the exact type, it MUST raise
- :c:data:`PyExc_BufferError`, set ``view->obj`` to ``NULL`` and
+ :exc:`BufferError`, set ``view->obj`` to ``NULL`` and
return ``-1``.
On success, fill in *view*, set ``view->obj`` to a new reference
@@ -531,7 +535,7 @@ Buffer-related functions
and :c:macro:`PyBUF_WRITABLE` is set in *flags*.
On success, set ``view->obj`` to a new reference to *exporter* and
- return 0. Otherwise, raise :c:data:`PyExc_BufferError`, set
+ return 0. Otherwise, raise :exc:`BufferError`, set
``view->obj`` to ``NULL`` and return ``-1``;
If this function is used as part of a :ref:`getbufferproc <buffer-structs>`,
diff --git a/Doc/c-api/typeobj.rst b/Doc/c-api/typeobj.rst
index 40cbcba..c2ed4e4 100644
--- a/Doc/c-api/typeobj.rst
+++ b/Doc/c-api/typeobj.rst
@@ -2357,7 +2357,7 @@ Buffer Object Structures
Except for point (3), an implementation of this function MUST take these
steps:
- (1) Check if the request can be met. If not, raise :c:data:`PyExc_BufferError`,
+ (1) Check if the request can be met. If not, raise :exc:`BufferError`,
set :c:expr:`view->obj` to ``NULL`` and return ``-1``.
(2) Fill in the requested fields.