Browse files

[1.6.x] Added some doc links for django.contrib.messages

Backport of b6178fa from master
  • Loading branch information...
1 parent b720ece commit 8bd5251fd5ff32e19315f51edf3cff24bc5ccc5c @timgraham timgraham committed Aug 14, 2013
Showing with 10 additions and 5 deletions.
  1. +7 −4 docs/ref/contrib/messages.txt
  2. +3 −1 docs/ref/settings.txt
11 docs/ref/contrib/messages.txt
@@ -54,20 +54,21 @@ Storage backends
The messages framework can use different backends to store temporary messages.
-Django provides three built-in storage classes:
+Django provides three built-in storage classes in
-.. class::
+.. class:: storage.session.SessionStorage
This class stores all messages inside of the request's session. Therefore
it requires Django's ``contrib.sessions`` application.
-.. class::
+.. class:: storage.cookie.CookieStorage
This class stores the message data in a cookie (signed with a secret hash
to prevent manipulation) to persist notifications across requests. Old
messages are dropped if the cookie data size would exceed 2048 bytes.
-.. class::
+.. class:: storage.fallback.FallbackStorage
This class first uses ``CookieStorage``, and falls back to using
``SessionStorage`` for the messages that could not fit in a single cookie.
@@ -83,6 +84,8 @@ path, for example::
+.. class:: storage.base.BaseStorage
To write your own storage class, subclass the ``BaseStorage`` class in
```` and implement the ``_get`` and
``_store`` methods.
4 docs/ref/settings.txt
@@ -2241,7 +2241,9 @@ Controls where Django stores message data. Valid values are:
See :ref:`message storage backends <message-storage-backends>` for more details.
-The backends that use cookies -- ``CookieStorage`` and ``FallbackStorage`` --
+The backends that use cookies --
+:class:`` and
+:class:`` --
use the value of :setting:`SESSION_COOKIE_DOMAIN` when setting their cookies.
.. setting:: MESSAGE_TAGS

0 comments on commit 8bd5251

Please sign in to comment.