]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 18 May 2022 09:00:22 +0000 (02:00 -0700)
committerGitHub <noreply@github.com>
Wed, 18 May 2022 09:00:22 +0000 (02:00 -0700)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28039863b014f57a1ac93b51e20920ebe7b)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Doc/c-api/refcounting.rst

index 391907c8c2976ac71f79932be287766a8d4d33e9..738bd77e9ce42fc051e301a35dfc80ac0964cdf8 100644 (file)
@@ -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:: void Py_IncRef(PyObject *o)
+
+   Increment the reference count for object *o*. A function version of :c:func:`Py_XINCREF`.
+   It can be used for runtime dynamic embedding of Python.
+
+
+.. c:function:: void Py_DecRef(PyObject *o)
+
+   Decrement the reference count for object *o*. A function version of :c:func:`Py_XDECREF`.
+   It can be used 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`,