aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorThomas Kemmer <tkemmer@computer.org>2015-08-28 16:30:38 +0200
committerThomas Kemmer <tkemmer@computer.org>2015-08-28 20:32:02 +0200
commitb6bc3508609fcdaab3cae50648a35ea44f7b6112 (patch)
tree26a0791095133bccbcb3f4cb52661a37e5dcab2b /README.rst
parent00f1aef41d96b32d0bac1d8afcfd69f030c046c0 (diff)
downloadcachetools-b6bc3508609fcdaab3cae50648a35ea44f7b6112.tar.gz
Code/interface cleanup and documentation.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 284bd30..c7e1115 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,7 @@ cachetools
========================================================================
This module provides various memoizing collections and decorators,
-including a variant of the Python 3 Standard Library `@lru_cache`_
+including variants of the Python 3 Standard Library `@lru_cache`_
function decorator.
.. code-block:: pycon
@@ -28,12 +28,12 @@ which item(s) to discard based on a suitable `cache algorithm`_. In
general, a cache's size is the total size of its items, and an item's
size is a property or function of its value, e.g. the result of
``sys.getsizeof(value)``. For the trivial but common case that each
-item counts as ``1``, irrespective of its value, a cache's size is
-equal to the number of its items, or ``len(cache)``.
+item counts as ``1``, a cache's size is equal to the number of its
+items, or ``len(cache)``.
-This module provides multiple cache implementations based on different
-cache algorithms, as well as decorators for easily memoizing function
-and method calls.
+The `cachetools` module implements multiple cache classes based on
+different caching algorithms, as well as decorators for easily
+memoizing function and method calls.
Installation