From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 11 Aug 2023 16:13:53 +0000 (-0700)
Subject: [3.11] Docs: Document PyBUF_MAX_NDIM (GH-107865) (#107872)
X-Git-Tag: v3.11.5~75
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4ddfb042609bebe7fd1d9af5f5d7bbc781ea5b4f;p=thirdparty%2FPython%2Fcpython.git

[3.11] Docs: Document PyBUF_MAX_NDIM (GH-107865) (#107872)

(cherry picked from commit 637f7ff2c60f262659da0334f1cb672bd361f398)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
---

diff --git a/Doc/c-api/buffer.rst b/Doc/c-api/buffer.rst
index 8ca1c190dab9..ba391a5279f2 100644
--- a/Doc/c-api/buffer.rst
+++ b/Doc/c-api/buffer.rst
@@ -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