Skip to content

Commit

Permalink
bpo-47220: Document the optional callback parameter of weakref.WeakMe…
Browse files Browse the repository at this point in the history
…thod (GH-25491)
  • Loading branch information
geryogam authored Nov 30, 2022
1 parent bf94c65 commit 9628136
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 4 additions & 2 deletions Doc/library/weakref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).
Expand All @@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Document the optional *callback* parameter of :class:`WeakMethod`. Patch by
Géry Ogam.

0 comments on commit 9628136

Please sign in to comment.