Skip to content

Commit

Permalink
bpo-29474: Improve documentation for weakref.WeakValueDictionary (#23)
Browse files Browse the repository at this point in the history
There were some grammatical errors in weakref.WeakValueDictionary
documentation.
  • Loading branch information
Mariatta authored Feb 12, 2017
1 parent c6d2f49 commit ae82871
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Doc/library/weakref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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()
Expand Down

0 comments on commit ae82871

Please sign in to comment.