summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Haritonov <reclosedev@gmail.com>2013-02-24 15:39:21 +0400
committerRoman Haritonov <reclosedev@gmail.com>2013-02-24 15:39:21 +0400
commitd27d326541dcc4b81f87fc70ae55396b89cf0279 (patch)
treef70b75727b8dd4b4addf4877d4bd44443b6ab1af
parentc6523d35d733dbe850187fcf25419712d2961f0a (diff)
downloadrequests-cache-v1.x.x.tar.gz
Document backward incompatible changesv1.x.x
-rw-r--r--HISTORY.rst7
-rw-r--r--docs/index.rst3
-rw-r--r--docs/user_guide.rst15
3 files changed, 24 insertions, 1 deletions
diff --git a/HISTORY.rst b/HISTORY.rst
index 21fc1b1..d1bdd8b 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -3,6 +3,13 @@
History
-------
+0.3.0 (2013-02-24)
++++++++++++++++++++
+
+* Support for ``Requests`` 1.x.x
+* ``CachedSession``
+* Many backward incompatible changes
+
0.2.1 (2013-01-13)
+++++++++++++++++++
diff --git a/docs/index.rst b/docs/index.rst
index ad390d1..dd75dea 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -7,7 +7,8 @@ Requests-cache documentation
============================
`Requests-cache <http://pypi.python.org/pypi/requests-cache>`_
-is a transparent persistent cache for requests_ (version >= 1.1.0) library.
+is a transparent persistent cache for requests_ (version >= 1.1.0
+see :ref:`incompatible_changes`) library.
Source code and issue tracking can be found at
`GitHub <https://github.com/reclosedev/requests-cache>`_.
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
index 08296ac..ca3c9e4 100644
--- a/docs/user_guide.rst
+++ b/docs/user_guide.rst
@@ -134,6 +134,21 @@ List of available backends:
You can write your own and pass instance to :func:`install_cache` or :class:`CachedSession` constructor.
See :ref:`cache_backends` API documentation and sources.
+
+.. _incompatible_changes:
+
+Backward incompatible changes
+-----------------------------
+
+There is backward incompatible changes introduced in version 0.3.0:
+
+* `expire_after` is now seconds
+* UTC time in cache
+* Deleted ``requests_cache.enabled()`` context manager
+* Storage backends are now using hash for keys
+* Renamed methods in backends
+
+
----------------------
For more information see :doc:`API reference <api>` .