Django

Code

Changeset 3685

Show
Ignore:
Timestamp:
08/30/06 22:50:59 (2 years ago)
Author:
adrian
Message:

Fixed #2610 -- Clarified docs on 'messages' variable for auth context processor

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • django/trunk/docs/templates_python.txt

    r3670 r3685  
    301301      logged-in user (or an ``AnonymousUser`` instance, if the client isn't 
    302302      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 
    310312    * ``perms`` -- An instance of 
    311313      ``django.core.context_processors.PermWrapper``, representing the 
    …… 
    314316 
    315317.. _user authentication docs: http://www.djangoproject.com/documentation/authentication/#users 
     318.. _message docs: http://www.djangoproject.com/documentation/authentication/#messages 
    316319.. _permissions docs: http://www.djangoproject.com/documentation/authentication/#permissions 
    317320