summaryrefslogtreecommitdiff
path: root/docs/templates_python.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/templates_python.txt')
-rw-r--r--docs/templates_python.txt16
1 files changed, 11 insertions, 5 deletions
diff --git a/docs/templates_python.txt b/docs/templates_python.txt
index 62069ffd6a..8da589a125 100644
--- a/docs/templates_python.txt
+++ b/docs/templates_python.txt
@@ -300,11 +300,17 @@ If ``TEMPLATE_CONTEXT_PROCESSORS`` contains this processor, every
* ``user`` -- An ``auth.User`` instance representing the currently
logged-in user (or an ``AnonymousUser`` instance, if the client isn't
logged in). See the `user authentication docs`.
- * ``messages`` -- A list of ``auth.Message`` objects for the currently
- logged-in user.
- * ``perms`` -- An instance of ``django.core.context_processors.PermWrapper``,
- representing the permissions that the currently logged-in user has. See
- the `permissions docs`_.
+
+ * ``messages`` -- Returns a list of messages for the currently logged-in
+ user (set with ``user.add_message()``). Behind the scenes, this calls
+ ``request.user.get_and_delete_messages()``, which iterates over user's
+ messages and returns the actual message before deleting the ``Message``
+ object.
+
+ * ``perms`` -- An instance of
+ ``django.core.context_processors.PermWrapper``, representing the
+ permissions that the currently logged-in user has. See the `permissions
+ docs`_.
.. _user authentication docs: http://www.djangoproject.com/documentation/authentication/#users
.. _permissions docs: http://www.djangoproject.com/documentation/authentication/#permissions