Corrected an error in the information on supporting weak references in

extension types (the docs reflected a development version of the API).

This closes SF bug #435066.

diff --git a/Doc/lib/libweakref.tex b/Doc/lib/libweakref.tex
index 077e25cdae06ba2db9c6668a3c7998f786cac3ab..0d92ea9cd138a4f061942eb3bdfad9f2977fb833 100644 (file)
--- a/Doc/lib/libweakref.tex
+++ b/Doc/lib/libweakref.tex
@@ -226,28 +226,26 @@ PyTypeObject PyInstance_Type = {
     0,
     "instance",
 
-    /* lots of stuff omitted for brevity */
+    /* Lots of stuff omitted for brevity... */
 
     offsetof(PyInstanceObject, in_weakreflist) /* tp_weaklistoffset */
 };
 \end{verbatim}
 
 The only further addition is that the destructor needs to call the
-weak reference manager to clear any weak references and return if the
-object has been resurrected.  This needs to occur before any other
-parts of the destruction have occurred:
+weak reference manager to clear any weak references.  This should be
+done before any other parts of the destruction have occurred:
 
 \begin{verbatim}
 static void
 instance_dealloc(PyInstanceObject *inst)
 {
-    /* allocate tempories if needed, but do not begin
-       destruction here
+    /* Allocate tempories if needed, but do not begin
+       destruction just yet.
      */
 
-    if (!PyObject_ClearWeakRefs((PyObject *) inst))
-        return;
+    PyObject_ClearWeakRefs((PyObject *) inst);
 
-    /* proceed with object destuction normally */
+    /* Proceed with object destuction normally. */
 }
 \end{verbatim}