summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGéry Ogam <gery.ogam@gmail.com>2022-11-30 19:44:10 (GMT)
committerGitHub <noreply@github.com>2022-11-30 19:44:10 (GMT)
commit9628136fac997847b4662e6a17faf06d2a0507eb (patch)
treea2df55b34977bf865522748293aee768567b85ee /Doc/library
parentbf94c653f4291ba2db506453e0e00a82fe06b70a (diff)
downloadcpython-9628136fac997847b4662e6a17faf06d2a0507eb.zip
cpython-9628136fac997847b4662e6a17faf06d2a0507eb.tar.gz
cpython-9628136fac997847b4662e6a17faf06d2a0507eb.tar.bz2
bpo-47220: Document the optional callback parameter of weakref.WeakMethod (GH-25491)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/weakref.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst
index a1e542b..73e7b21 100644
--- a/Doc/library/weakref.rst
+++ b/Doc/library/weakref.rst
@@ -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)