From 5e69536f7c0c5cac925560cabd277b6a59a8d0ef Mon Sep 17 00:00:00 2001 From: Adrian Holovaty Date: Thu, 31 Aug 2006 03:50:59 +0000 Subject: [PATCH] Fixed #2610 -- Clarified docs on 'messages' variable for auth context processor git-svn-id: http://code.djangoproject.com/svn/django/trunk@3685 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/templates_python.txt | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/templates_python.txt b/docs/templates_python.txt index 8da589a1252..aa7fa901b0b 100644 --- a/docs/templates_python.txt +++ b/docs/templates_python.txt @@ -300,19 +300,22 @@ 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`` -- 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. - + + * ``messages`` -- A list of messages (as strings) for the currently + logged-in user. Behind the scenes, this calls + ``request.user.get_and_delete_messages()`` for every request. That method + collects the user's messages and deletes them from the database. + + Note that messages are set with ``user.add_message()``. See the + `message docs`_ for more. + * ``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 +.. _message docs: http://www.djangoproject.com/documentation/authentication/#messages .. _permissions docs: http://www.djangoproject.com/documentation/authentication/#permissions django.core.context_processors.debug