mirror of
https://github.com/python/cpython
synced 2024-09-05 00:05:39 +00:00
gh-107298: Fix C API Buffer documentation (#108011)
This commit is contained in:
parent
f2a9dfdee9
commit
c2941cba7a
|
@ -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>`,
|
||||
|
|
|
@ -2443,7 +2443,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.
|
||||
|
|
|
@ -2,7 +2,6 @@
|
|||
# as tested on the CI via check-warnings.py in reusable-docs.yml.
|
||||
# Keep lines sorted lexicographically to help avoid merge conflicts.
|
||||
|
||||
Doc/c-api/buffer.rst
|
||||
Doc/c-api/datetime.rst
|
||||
Doc/c-api/descriptor.rst
|
||||
Doc/c-api/exceptions.rst
|
||||
|
|
Loading…
Reference in a new issue