Skip to content

Commit 4061261

Browse files
committed
Improve Deque and Index tutorial
1 parent ef087b9 commit 4061261

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/tutorial.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ Deque
479479
<https://docs.python.org/3/library/collections.html#collections.deque>`_-compatible
480480
double-ended queue. Deques are a generalization of stacks and queues with fast
481481
access and editing at both front and back sides. :class:`Deque
482-
<diskcache.Deque>` objects inherit the benefits of the :class:`Cache
482+
<diskcache.Deque>` objects inherit the benefits of :class:`Cache
483483
<diskcache.Cache>` objects but never evict items.
484484

485485
>>> from diskcache import Deque
@@ -512,7 +512,7 @@ Index
512512
<https://docs.python.org/3/library/collections.abc.html#collections-abstract-base-classes>`_
513513
and `ordered dictionary
514514
<https://docs.python.org/3/library/collections.html#collections.OrderedDict>`_
515-
interface. :class:`Index <diskcache.Index>` objects inherit the benefits of
515+
interface. :class:`Index <diskcache.Index>` objects inherit all the benefits of
516516
:class:`Cache <diskcache.Cache>` objects but never evict items.
517517

518518
>>> from diskcache import Index
@@ -533,7 +533,9 @@ interface. :class:`Index <diskcache.Index>` objects inherit the benefits of
533533
:class:`Index <diskcache.Index>` objects provide an efficient and safe means of
534534
cross-thread and cross-process communication. :class:`Index <diskcache.Index>`
535535
objects are also useful in scenarios where contents should remain persistent or
536-
limitations prohibit holding all items in memory at the same time.
536+
limitations prohibit holding all items in memory at the same time. The index
537+
uses a fixed amout of memory regardless of the size or number of items stored
538+
inside it.
537539

538540
.. _tutorial-recipes:
539541

0 commit comments

Comments
 (0)