summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorJack DeVries <58614260+jdevries3133@users.noreply.github.com>2021-06-29 17:28:03 (GMT)
committerGitHub <noreply@github.com>2021-06-29 17:28:03 (GMT)
commit12803c59d54ff1a45a5b08cef82652ef199b3b07 (patch)
treec1de268d0b7e019de7a6fc97a9df70cec14b6565 /Doc/library
parent823460daa9fab3d0cf00ec553d1e35635ef73d40 (diff)
downloadcpython-12803c59d54ff1a45a5b08cef82652ef199b3b07.zip
cpython-12803c59d54ff1a45a5b08cef82652ef199b3b07.tar.gz
cpython-12803c59d54ff1a45a5b08cef82652ef199b3b07.tar.bz2
bpo-38062: [doc] clarify that atexit uses equality comparisons internally. (GH-26935)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/atexit.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/atexit.rst b/Doc/library/atexit.rst
index e6fa33a..f7f0381 100644
--- a/Doc/library/atexit.rst
+++ b/Doc/library/atexit.rst
@@ -48,11 +48,12 @@ internal error is detected, or when :func:`os._exit` is called.
.. function:: unregister(func)
- Remove *func* from the list of functions to be run at interpreter
- shutdown. After calling :func:`unregister`, *func* is guaranteed not to be
- called when the interpreter shuts down, even if it was registered more than
- once. :func:`unregister` silently does nothing if *func* was not previously
- registered.
+ Remove *func* from the list of functions to be run at interpreter shutdown.
+ :func:`unregister` silently does nothing if *func* was not previously
+ registered. If *func* has been registered more than once, every occurrence
+ of that function in the :mod:`atexit` call stack will be removed. Equality
+ comparisons (``==``) are used internally during unregistration, so function
+ references do not need to have matching identities.
.. seealso::