From 4df636c0d7734a8b80b17c78f57968466d558844 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@plope.com>
Date: Wed, 22 Dec 2010 01:25:15 -0500
Subject: - Added flash messaging, as described in the "Flash Messaging"
 narrative   documentation chapter.

---
 docs/api/flash.rst      | 36 ++++++++++++++++++++++++++++++++++++
 docs/api/interfaces.rst |  1 +
 2 files changed, 37 insertions(+)
 create mode 100644 docs/api/flash.rst

(limited to 'docs/api')

diff --git a/docs/api/flash.rst b/docs/api/flash.rst
new file mode 100644
index 000000000..94907958d
--- /dev/null
+++ b/docs/api/flash.rst
@@ -0,0 +1,36 @@
+.. _flash_module:
+
+:mod:`pyramid.flash`
+--------------------
+
+Flash Category Constants
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following attributes represent constants for use as flash messaging
+category values (see :ref:`flash_chapter`).
+
+.. attribute:: DEBUG
+
+   An alternate spelling for the string ``debug``.  Represents development
+   debug messages.
+
+.. attribute:: INFO
+
+   An alternate spelling for the string ``info``.  Represents messages that
+   are informational for user consumption.
+
+.. attribute:: SUCCESS
+
+   An alternate spelling for the string ``success``.  Represents messages that
+   tell the user about a successful action.
+
+.. attribute:: WARNING
+
+   An alternate spelling for the string ``warning``.  Represents messages
+   that tell the user about a condition that is not a success, but is neither
+   an error.
+
+.. attribute:: ERROR
+
+   An alternate spelling for the string ``success``.  Represents messages
+   that tell the user about an unsuccessful action.
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index b3c14e5f7..dab64ba15 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -35,3 +35,4 @@ Other Interfaces
 
   .. autointerface:: ITemplateRenderer
 
+  .. autointerface:: IFlashMessages
-- 
cgit v1.2.3