]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491)
authorGéry Ogam <gery.ogam@gmail.com>
Wed, 30 Nov 2022 19:44:10 +0000 (20:44 +0100)
committerGitHub <noreply@github.com>
Wed, 30 Nov 2022 19:44:10 +0000 (13:44 -0600)
Doc/library/weakref.rst
Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst [new file with mode: 0644]

index a1e542b1e927e493b962adf4ba4f1380ef660a56..73e7b21ae405d23b49055b46e1327e5f73a28552 100644 (file)
@@ -143,7 +143,7 @@ See :ref:`__slots__ documentation <slots>` for details.
    ``ProxyType`` or ``CallableProxyType``, depending on whether *object* is
    callable.  Proxy objects are not :term:`hashable` regardless of the referent; this
    avoids a number of problems related to their fundamentally mutable nature, and
-   prevent their use as dictionary keys.  *callback* is the same as the parameter
+   prevents their use as dictionary keys.  *callback* is the same as the parameter
    of the same name to the :func:`ref` function.
 
    Accessing an attribute of the proxy object after the referent is
@@ -212,7 +212,7 @@ objects.
    discarded when no strong reference to it exists any more.
 
 
-.. class:: WeakMethod(method)
+.. class:: WeakMethod(method[, callback])
 
    A custom :class:`ref` subclass which simulates a weak reference to a bound
    method (i.e., a method defined on a class and looked up on an instance).
@@ -238,6 +238,8 @@ objects.
       >>> r()
       >>>
 
+   *callback* is the same as the parameter of the same name to the :func:`ref` function.
+
    .. versionadded:: 3.4
 
 .. class:: finalize(obj, func, /, *args, **kwargs)
diff --git a/Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst b/Misc/NEWS.d/next/Library/2022-04-04-22-54-11.bpo-47220.L9jYu4.rst
new file mode 100644 (file)
index 0000000..6e2af08
--- /dev/null
@@ -0,0 +1,2 @@
+Document the optional *callback* parameter of :class:`WeakMethod`. Patch by
+Géry Ogam.