Author: adrian
Date: 2006-08-30 22:50:59 -0500 (Wed, 30 Aug 2006)
New Revision: 3685

Modified:
   django/trunk/docs/templates_python.txt
Log:
Fixed #2610 -- Clarified docs on 'messages' variable for auth context processor

Modified: django/trunk/docs/templates_python.txt
===================================================================
--- django/trunk/docs/templates_python.txt      2006-08-31 03:45:08 UTC (rev 
3684)
+++ django/trunk/docs/templates_python.txt      2006-08-31 03:50:59 UTC (rev 
3685)
@@ -300,19 +300,22 @@
     * ``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


--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/django-updates
-~----------~----~----~----~------~----~------~--~---

Reply via email to