Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

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
  • Loading branch information...
commit 5e69536f7c0c5cac925560cabd277b6a59a8d0ef 1 parent 401b15d
Adrian Holovaty authored August 31, 2006

Showing 1 changed file with 10 additions and 7 deletions. Show diff stats Hide diff stats

  1. 17  docs/templates_python.txt
17  docs/templates_python.txt
@@ -300,19 +300,22 @@ If ``TEMPLATE_CONTEXT_PROCESSORS`` contains this processor, every
300 300
     * ``user`` -- An ``auth.User`` instance representing the currently
301 301
       logged-in user (or an ``AnonymousUser`` instance, if the client isn't
302 302
       logged in). See the `user authentication docs`.
303  
-      
304  
-    * ``messages`` -- Returns a list of messages for the currently logged-in
305  
-      user (set with ``user.add_message()``). Behind the scenes, this calls
306  
-      ``request.user.get_and_delete_messages()``, which iterates over user's
307  
-      messages and returns the actual message before deleting the ``Message``
308  
-      object.
309  
-      
  303
+
  304
+    * ``messages`` -- A list of messages (as strings) for the currently
  305
+      logged-in user. Behind the scenes, this calls
  306
+      ``request.user.get_and_delete_messages()`` for every request. That method
  307
+      collects the user's messages and deletes them from the database.
  308
+
  309
+      Note that messages are set with ``user.add_message()``. See the
  310
+      `message docs`_ for more.
  311
+
310 312
     * ``perms`` -- An instance of
311 313
       ``django.core.context_processors.PermWrapper``, representing the
312 314
       permissions that the currently logged-in user has. See the `permissions
313 315
       docs`_.
314 316
 
315 317
 .. _user authentication docs: http://www.djangoproject.com/documentation/authentication/#users
  318
+.. _message docs: http://www.djangoproject.com/documentation/authentication/#messages
316 319
 .. _permissions docs: http://www.djangoproject.com/documentation/authentication/#permissions
317 320
 
318 321
 django.core.context_processors.debug

0 notes on commit 5e69536

Please sign in to comment.
Something went wrong with that request. Please try again.