summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordaniel a rios <misterrios@gmail.com>2019-10-08 11:02:40 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2019-11-14 11:14:11 +0100
commitefc3e32d6d7fb9bb41be73b80c8607b653c1fbd6 (patch)
treefff79e28232a2d8088aee861606c924424771395 /docs
parent6e99585c19290fb9bec502cac8210041fdb28484 (diff)
Fixed #30759 -- Made cache.delete() return whether it succeeded.
Thanks Simon Charette for the review.
Diffstat (limited to 'docs')
-rw-r--r--docs/releases/3.1.txt3
-rw-r--r--docs/topics/cache.txt9
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/releases/3.1.txt b/docs/releases/3.1.txt
index de114e7098..f725e4e056 100644
--- a/docs/releases/3.1.txt
+++ b/docs/releases/3.1.txt
@@ -118,6 +118,9 @@ Cache
field names in the ``no-cache`` directive for the ``Cache-Control`` header,
according to :rfc:`7234#section-5.2.2.2`.
+* :meth:`~django.core.caches.cache.delete` now returns ``True`` if the key was
+ successfully deleted, ``False`` otherwise.
+
CSRF
~~~~
diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt
index ce030d4221..a038183d0d 100644
--- a/docs/topics/cache.txt
+++ b/docs/topics/cache.txt
@@ -724,6 +724,7 @@ a cached item, for example:
# cache key for {% cache 500 sidebar username %}
>>> key = make_template_fragment_key('sidebar', [username])
>>> cache.delete(key) # invalidates cached template fragment
+ True
.. _low-level-cache-api:
@@ -884,6 +885,14 @@ You can delete keys explicitly with ``delete()`` to clear the cache for a
particular object::
>>> cache.delete('a')
+ True
+
+``delete()`` returns ``True`` if the key was successfully deleted, ``False``
+otherwise.
+
+.. versionchanged:: 3.1
+
+ The boolean return value was added.
.. method:: cache.delete_many(keys, version=None)