gh-91755: Document Py_IncRef and Py_DecRef as C function.

python · erlend-aasland · May 18, 2022 · Apr 22, 2022 · Apr 22, 2022 · May 18, 2022
commit 50a0ce1da56e7cc9c19e0302ebb7b7e551f7658b
diff --git a/Doc/c-api/refcounting.rst b/Doc/c-api/refcounting.rst
@@ -109,11 +109,17 @@ objects.
   It is a good idea to use this macro whenever decrementing the reference
   count of an object that might be traversed during garbage collection.

+.. c:function:: Py_IncRef(PyObject *o)
+
+   :c:func:`Py_IncRef` is a simply exported function version of :c:func:`Py_XINCREF`,
+   which provides conveniences for runtime dynamic embedding of Python.
+
+
+.. c:function:: Py_DecRef(PyObject *o)
+
+   :c:func:`Py_DecRef` is a simply exported function version of :c:func:`Py_XDECREF`,
+   which provides conveniences for runtime dynamic embedding of Python.

-The following functions are for runtime dynamic embedding of Python:
-``Py_IncRef(PyObject *o)``, ``Py_DecRef(PyObject *o)``. They are
-simply exported function versions of :c:func:`Py_XINCREF` and
-:c:func:`Py_XDECREF`, respectively.

 The following functions or macros are only for use within the interpreter core:
 :c:func:`_Py_Dealloc`, :c:func:`_Py_ForgetReference`, :c:func:`_Py_NewReference`,