summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2012-08-20 22:07:35 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2012-08-20 22:07:35 (GMT)
commit609939e22f955eeb9eed91ba8337ed0d2ddae202 (patch)
tree2681660dca17bc338c478612a2907cb708dc2d22 /Doc
parent77ebfccd4d58040bb9a9ea5eba18e895ec201d34 (diff)
parent9439f04b9af6d31d8ff6fb5601d32d004946e9cc (diff)
downloadcpython-609939e22f955eeb9eed91ba8337ed0d2ddae202.zip
cpython-609939e22f955eeb9eed91ba8337ed0d2ddae202.tar.gz
cpython-609939e22f955eeb9eed91ba8337ed0d2ddae202.tar.bz2
Issue #14954: Clarify the interaction of weak references and garbage collection.
Patch by Ethan Furman.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/weakref.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst
index 2ad1e56..224f442 100644
--- a/Doc/library/weakref.rst
+++ b/Doc/library/weakref.rst
@@ -24,7 +24,10 @@ by a weak reference.
A weak reference to an object is not enough to keep the object alive: when the
only remaining references to a referent are weak references,
:term:`garbage collection` is free to destroy the referent and reuse its memory
-for something else. A primary use for weak references is to implement caches or
+for something else. However, until the object is actually destroyed the weak
+reference may return the object even if there are no strong references to it.
+
+A primary use for weak references is to implement caches or
mappings holding large objects, where it's desired that a large object not be
kept alive solely because it appears in a cache or mapping.