From 24fcca6bddca3db33ac73c29ad9167ac279e4d94 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9my=20HUBSCHER?= <remy.hubscher@novapost.fr>
Date: Thu, 12 Dec 2013 11:45:27 +0100
Subject: [PATCH] Fixed #21591 -- Added documentation about
 contrib.messages.get_messages.

Refs https://code.djangoproject.com/ticket/21591
Thanks to track user merb for the report.
---
 docs/ref/contrib/messages.txt | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/docs/ref/contrib/messages.txt b/docs/ref/contrib/messages.txt
index 690b73d195..487e1dd86c 100644
--- a/docs/ref/contrib/messages.txt
+++ b/docs/ref/contrib/messages.txt
@@ -177,8 +177,9 @@ used tags (which are usually represented as HTML classes for the message)::
 
 Displaying messages
 -------------------
+.. function:: get_messages(request)
 
-In your template, use something like::
+**In your template**, use something like::
 
     {% if messages %}
     <ul class="messages">
@@ -212,6 +213,25 @@ is a mapping of the message level names to their numeric value::
     </ul>
     {% endif %}
 
+
+
+**Outside of templates**, you can use
+:func:`~django.contrib.messages.get_messages`::
+
+    from django.contrib.messages import get_messages
+
+    storage = get_messages(request)
+    for message in storage:
+        do_something_with_the_message(message)
+
+For instance, you can fetch all the messages to return them in a
+:ref:`JSONResponseMixin <jsonresponsemixin-example>` instead of a
+:class:`~django.views.generic.base.TemplateResponseMixin`.
+
+:func:`~django.contrib.messages.get_messages` will return an
+instance of the configured storage backend.
+
+
 The ``Message`` class
 ---------------------