Skip to content

Commit

Permalink
[3.11] Docs: Document PyBUF_MAX_NDIM (GH-107865) (#107872)
Browse files Browse the repository at this point in the history
(cherry picked from commit 637f7ff)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
  • Loading branch information
miss-islington and erlend-aasland committed Aug 11, 2023
1 parent 202efe1 commit 4ddfb04
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions Doc/c-api/buffer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,14 @@ a buffer, see :c:func:`PyObject_GetBuffer`.
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``.
The maximum number of dimensions is given by :c:macro:`PyBUF_MAX_NDIM`.

The macro :c:macro:`PyBUF_MAX_NDIM` limits the maximum number of dimensions
to 64. Exporters MUST respect this limit, consumers of multi-dimensional
buffers SHOULD be able to handle up to :c:macro:`PyBUF_MAX_NDIM` dimensions.
.. :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
Expand Down

0 comments on commit 4ddfb04

Please sign in to comment.