summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMariatta <Mariatta@users.noreply.github.com>2017-02-12 16:21:36 (GMT)
committerGitHub <noreply@github.com>2017-02-12 16:21:36 (GMT)
commitae828714ebdb7a0d69bf23c1f6d606e5e63bdcfe (patch)
treea48728c9b0fd7c39e6d377c54d39fec4f8f22cb9
parentc6d2f498142c29ed62241ab6d89cb7b5e38f2fca (diff)
downloadcpython-ae828714ebdb7a0d69bf23c1f6d606e5e63bdcfe.zip
cpython-ae828714ebdb7a0d69bf23c1f6d606e5e63bdcfe.tar.gz
cpython-ae828714ebdb7a0d69bf23c1f6d606e5e63bdcfe.tar.bz2
bpo-29474: Improve documentation for weakref.WeakValueDictionary (#23)
There were some grammatical errors in weakref.WeakValueDictionary documentation.
-rw-r--r--Doc/library/weakref.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst
index e289b97..b02a006 100644
--- a/Doc/library/weakref.rst
+++ b/Doc/library/weakref.rst
@@ -166,8 +166,8 @@ Extension types can easily be made to support weak references; see
performed by the program during iteration may cause items in the
dictionary to vanish "by magic" (as a side effect of garbage collection).
-:class:`WeakKeyDictionary` objects have the following additional methods. These
-expose the internal references directly. The references are not guaranteed to
+:class:`WeakKeyDictionary` objects have an additional method that
+exposes the internal references directly. The references are not guaranteed to
be "live" at the time they are used, so the result of calling the references
needs to be checked before being used. This can be used to avoid creating
references that will cause the garbage collector to keep the keys around longer
@@ -192,9 +192,9 @@ than needed.
by the program during iteration may cause items in the dictionary to vanish "by
magic" (as a side effect of garbage collection).
-:class:`WeakValueDictionary` objects have the following additional methods.
-These method have the same issues as the and :meth:`keyrefs` method of
-:class:`WeakKeyDictionary` objects.
+:class:`WeakValueDictionary` objects have an additional method that has the
+same issues as the :meth:`keyrefs` method of :class:`WeakKeyDictionary`
+objects.
.. method:: WeakValueDictionary.valuerefs()