gh-89653: PEP 670: Amend docs (GH-91813)

diff --git a/Doc/c-api/list.rst b/Doc/c-api/list.rst
index f338e2ae0668956d68fd2fb95cb92a67bb65faff..f9e65354a259f4859c44a7ccc14f9bbdf745e806 100644 (file)
--- a/Doc/c-api/list.rst
+++ b/Doc/c-api/list.rst
@@ -53,7 +53,7 @@ List Objects
 
 .. c:function:: Py_ssize_t PyList_GET_SIZE(PyObject *list)
 
-   Macro form of :c:func:`PyList_Size` without error checking.
+   Similar to :c:func:`PyList_Size`, but without error checking.
 
 
 .. c:function:: PyObject* PyList_GetItem(PyObject *list, Py_ssize_t index)
@@ -66,7 +66,7 @@ List Objects
 
 .. c:function:: PyObject* PyList_GET_ITEM(PyObject *list, Py_ssize_t i)
 
-   Macro form of :c:func:`PyList_GetItem` without error checking.
+   Similar to :c:func:`PyList_GetItem`, but without error checking.
 
 
 .. c:function:: int PyList_SetItem(PyObject *list, Py_ssize_t index, PyObject *item)

diff --git a/Doc/c-api/tuple.rst b/Doc/c-api/tuple.rst
index 6919e61022788f0a67b722fbe9341c9a96f9b99f..9b85522600d4e755eaf99dd74a85491bea2c313d 100644 (file)
--- a/Doc/c-api/tuple.rst
+++ b/Doc/c-api/tuple.rst
@@ -91,7 +91,7 @@ Tuple Objects
 
    .. note::
 
-      This macro "steals" a reference to *o*, and, unlike
+      This function "steals" a reference to *o*, and, unlike
       :c:func:`PyTuple_SetItem`, does *not* discard a reference to any item that
       is being replaced; any reference in the tuple at position *pos* will be
       leaked.
@@ -215,7 +215,8 @@ type.
 
 .. c:function:: void PyStructSequence_SET_ITEM(PyObject *p, Py_ssize_t *pos, PyObject *o)
 
-   Macro equivalent of :c:func:`PyStructSequence_SetItem`.
+   Similar to :c:func:`PyStructSequence_SetItem`, but implemented as a static
+   inlined function.
 
    .. note::
 

diff --git a/Doc/c-api/unicode.rst b/Doc/c-api/unicode.rst
index 11aa751cdad1536b118b71cba07878ee88a0acea..00faac5b69abdb43a9c16fe12176e2c409299abb 100644 (file)
--- a/Doc/c-api/unicode.rst
+++ b/Doc/c-api/unicode.rst
@@ -84,8 +84,8 @@ Python:
    is exposed to Python code as ``str``.
 
 
-The following APIs are really C macros and can be used to do fast checks and to
-access internal read-only data of Unicode objects:
+The following APIs are C macros and static inlined functions for fast checks and
+access to internal read-only data of Unicode objects:
 
 .. c:function:: int PyUnicode_Check(PyObject *o)
 
@@ -168,20 +168,21 @@ access internal read-only data of Unicode objects:
    .. versionadded:: 3.3
 
 
-.. c:function:: void PyUnicode_WRITE(int kind, void *data, Py_ssize_t index, \
-                                     Py_UCS4 value)
+.. c:function:: void PyUnicode_WRITE(unsigned int kind, void *data, \
+                                     Py_ssize_t index, Py_UCS4 value)
 
    Write into a canonical representation *data* (as obtained with
-   :c:func:`PyUnicode_DATA`).  This macro does not do any sanity checks and is
+   :c:func:`PyUnicode_DATA`).  This function performs no sanity checks, and is
    intended for usage in loops.  The caller should cache the *kind* value and
-   *data* pointer as obtained from other macro calls.  *index* is the index in
+   *data* pointer as obtained from other calls.  *index* is the index in
    the string (starts at 0) and *value* is the new code point value which should
    be written to that location.
 
    .. versionadded:: 3.3
 
 
-.. c:function:: Py_UCS4 PyUnicode_READ(int kind, void *data, Py_ssize_t index)
+.. c:function:: Py_UCS4 PyUnicode_READ(unsigned int kind, void *data, \
+                                       Py_ssize_t index)
 
    Read a code point from a canonical representation *data* (as obtained with
    :c:func:`PyUnicode_DATA`).  No checks or ready calls are performed.
@@ -198,7 +199,7 @@ access internal read-only data of Unicode objects:
    .. versionadded:: 3.3
 
 
-.. c:macro:: PyUnicode_MAX_CHAR_VALUE(o)
+.. c:function:: Py_UCS4 PyUnicode_MAX_CHAR_VALUE(PyObject *o)
 
    Return the maximum code point that is suitable for creating another string
    based on *o*, which must be in the "canonical" representation.  This is
@@ -239,7 +240,7 @@ access internal read-only data of Unicode objects:
    a Unicode object (not checked).
 
    .. versionchanged:: 3.3
-      This macro is now inefficient -- because in many cases the
+      This function is now inefficient -- because in many cases the
       :c:type:`Py_UNICODE` representation does not exist and needs to be created
       -- and can fail (return ``NULL`` with an exception set).  Try to port the
       code to use the new :c:func:`PyUnicode_nBYTE_DATA` macros or use
@@ -642,8 +643,8 @@ APIs:
 .. c:function:: Py_UCS4 PyUnicode_ReadChar(PyObject *unicode, Py_ssize_t index)
 
    Read a character from a string.  This function checks that *unicode* is a
-   Unicode object and the index is not out of bounds, in contrast to the macro
-   version :c:func:`PyUnicode_READ_CHAR`.
+   Unicode object and the index is not out of bounds, in contrast to
+   :c:func:`PyUnicode_READ_CHAR`, which performs no error checking.
 
    .. versionadded:: 3.3
 

diff --git a/Doc/c-api/weakref.rst b/Doc/c-api/weakref.rst
index 98ebe711adaeb46f2011df2502ae3817bad54660..7b32e17a2397298f578722d86b272ec23e40f051 100644 (file)
--- a/Doc/c-api/weakref.rst
+++ b/Doc/c-api/weakref.rst
@@ -66,5 +66,4 @@ as much as it can.
 
 .. c:function:: PyObject* PyWeakref_GET_OBJECT(PyObject *ref)
 
-   Similar to :c:func:`PyWeakref_GetObject`, but implemented as a macro that does no
-   error checking.
+   Similar to :c:func:`PyWeakref_GetObject`, but does no error checking.