]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Doc: Update Py_TPFLAGS_HAVE_FINALIZE in docs (GH-96273)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 30 Aug 2022 08:38:53 +0000 (01:38 -0700)
committerGitHub <noreply@github.com>
Tue, 30 Aug 2022 08:38:53 +0000 (01:38 -0700)
It is now deprecated and the docs should reflect that.
(cherry picked from commit 9625de6fab4597bcd04ec390b680b053b0533816)

Co-authored-by: da-woods <dw-git@d-woods.co.uk>
Doc/c-api/typeobj.rst

index 9bb0e6dbbcf87dd389680f061f68b476b6a66698..b939d930b18c68989ed2a432da71a0a23fb02cf8 100644 (file)
@@ -1990,9 +1990,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
@@ -2010,6 +2007,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`)