]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] Doc: C API: Delete claim that `PyObject_Init` is GC-aware (GH-126418) (#126432)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 5 Nov 2024 10:01:37 +0000 (11:01 +0100)
committerGitHub <noreply@github.com>
Tue, 5 Nov 2024 10:01:37 +0000 (15:31 +0530)
Doc: C API: Delete claim that `PyObject_Init` is GC-aware (GH-126418)
(cherry picked from commit 407c0366d9ccd2a36c6cc8bf92324856b16fd604)

Co-authored-by: Richard Hansen <rhansen@rhansen.org>
Doc/c-api/allocation.rst

index b3609c233156b6e02e530b53083e347c271c20a9..e6ff40ab46e7c2f7b7cdde044804c1cfd450cfe7 100644 (file)
@@ -15,10 +15,8 @@ Allocating Objects on the Heap
 .. c:function:: PyObject* PyObject_Init(PyObject *op, PyTypeObject *type)
 
    Initialize a newly allocated object *op* with its type and initial
-   reference.  Returns the initialized object.  If *type* indicates that the
-   object participates in the cyclic garbage detector, it is added to the
-   detector's set of observed objects. Other fields of the object are not
-   affected.
+   reference.  Returns the initialized object.  Other fields of the object are
+   not affected.
 
 
 .. c:function:: PyVarObject* PyObject_InitVar(PyVarObject *op, PyTypeObject *type, Py_ssize_t size)