Browse files

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

… processor

git-svn-id: bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
1 parent 401b15d commit 5e69536f7c0c5cac925560cabd277b6a59a8d0ef @adrianholovaty adrianholovaty committed Aug 31, 2006
Showing with 10 additions and 7 deletions.
  1. +10 −7 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
.. _user authentication docs:
+.. _message docs:
.. _permissions docs:

0 comments on commit 5e69536

Please sign in to comment.