]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Doc: Update Py_TPFLAGS_HAVE_FINALIZE in docs (GH-96273)
authorda-woods <dw-git@d-woods.co.uk>
Tue, 30 Aug 2022 08:31:14 +0000 (09:31 +0100)
committerGitHub <noreply@github.com>
Tue, 30 Aug 2022 08:31:14 +0000 (17:31 +0900)
It is now deprecated and the docs should reflect that.

Doc/c-api/typeobj.rst

index dfe91ee358d0acffc373f143b6698ec70089442d..20cdffed110cce1e88a67523120790045ffe3512 100644 (file)
@@ -2005,9 +2005,6 @@ and :c:type:`PyType_Type` effectively act as defaults.)
           PyErr_Restore(error_type, error_value, error_traceback);
       }
 
-   For this field to be taken into account (even through inheritance),
-   you must also set the :const:`Py_TPFLAGS_HAVE_FINALIZE` flags bit.
-
    Also, note that, in a garbage collected Python,
    :c:member:`~PyTypeObject.tp_dealloc` may be called from
    any Python thread, not just the thread which created the object (if the object
@@ -2025,6 +2022,12 @@ and :c:type:`PyType_Type` effectively act as defaults.)
 
    .. versionadded:: 3.4
 
+   .. versionchanged:: 3.8
+
+      Before version 3.8 it was necessary to set the
+      :const:`Py_TPFLAGS_HAVE_FINALIZE` flags bit in order for this field to be
+      used.  This is no longer required.
+
    .. seealso:: "Safe object finalization" (:pep:`442`)