summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst3
-rw-r--r--docs/user_guide.rst15
2 files changed, 17 insertions, 1 deletions
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>` .