aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorThomas Kemmer <tkemmer@computer.org>2014-03-22 13:03:32 +0100
committerThomas Kemmer <tkemmer@computer.org>2014-03-22 13:03:32 +0100
commit37c58d04f5357140c18d7117702598039451744d (patch)
treeb32ab5f7c323a942704174ab375d86da9bf0e027 /README.rst
parenta34b1fa18a3494b6501dc5eaf8114e507fe88cc9 (diff)
downloadcachetools-37c58d04f5357140c18d7117702598039451744d.tar.gz
Update documentation.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst12
1 files changed, 5 insertions, 7 deletions
diff --git a/README.rst b/README.rst
index afe3375..e310f47 100644
--- a/README.rst
+++ b/README.rst
@@ -2,13 +2,11 @@ cachetools
========================================================================
This module provides various memoizing collections and function
-decorators, including a variant of the Python 3 functools.lru_cache_
-decorator.
+decorators, including a variant of the Python 3 Standard Library
+lru_cache_ decorator.
-.. note::
-
- This module is in early pre-alpha, and not fit for *any* purpose
- (yet).
+ Important Note: This module is in early pre-alpha, and not fit for
+ *any* purpose (yet).
.. code-block:: pycon
@@ -56,7 +54,7 @@ cachetools is Copyright 2014 Thomas Kemmer.
Licensed under the `MIT License`_.
-.. _functools.lru_cache: http://docs.python.org/3.4/library/functools.html#functools.lru_cache
+.. _lru_cache: http://docs.python.org/3.4/library/functools.html#functools.lru_cache
.. _Documentation: http://pythonhosted.org/cachetools/
.. _Source Code: https://github.com/tkem/cachetools/