Document PyObject_ClearWeakRefs

hugovk · hugovk · commit 1465769be3d8 · 2023-03-11T22:26:26.000+02:00
diff --git a/Doc/c-api/weakref.rst b/Doc/c-api/weakref.rst
@@ -67,3 +67,13 @@ as much as it can.
 .. c:function:: PyObject* PyWeakref_GET_OBJECT(PyObject *ref)
 
    Similar to :c:func:`PyWeakref_GetObject`, but does no error checking.
+
+
+.. c:function:: void PyObject_ClearWeakRefs(PyObject *object)
+
+   This function is called by the :c:member:`~PyTypeObject.tp_dealloc` handler
+   to clear weak references.
+
+   This iterates through the weak references for *object* and calls callbacks
+   for those references which have one. It returns when all callbacks have
+   been attempted.
diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
@@ -960,7 +960,7 @@ Porting to Python 3.12
   Classes declaring :const:`Py_TPFLAGS_MANAGED_DICT` should call
   :c:func:`!_PyObject_VisitManagedDict` and :c:func:`!_PyObject_ClearManagedDict`
   to traverse and clear their instance's dictionaries.
-  To clear weakrefs, call :c:func:`!PyObject_ClearWeakRefs`, as before.
+  To clear weakrefs, call :c:func:`PyObject_ClearWeakRefs`, as before.
 
 * The :c:func:`PyUnicode_FSDecoder` function no longer accepts bytes-like
   paths, like :class:`bytearray` and :class:`memoryview` types: only the exact
