diff options
| author | Chris McDonough <chrism@plope.com> | 2010-12-22 01:25:15 -0500 |
|---|---|---|
| committer | Chris McDonough <chrism@plope.com> | 2010-12-22 01:25:15 -0500 |
| commit | 4df636c0d7734a8b80b17c78f57968466d558844 (patch) | |
| tree | 4fbdabab5727fff8a911d22d915bc16a3e228106 /docs/api | |
| parent | fa3bf3d7634137bdffc121ae318609a1ea13792c (diff) | |
| download | pyramid-4df636c0d7734a8b80b17c78f57968466d558844.tar.gz pyramid-4df636c0d7734a8b80b17c78f57968466d558844.tar.bz2 pyramid-4df636c0d7734a8b80b17c78f57968466d558844.zip | |
- Added flash messaging, as described in the "Flash Messaging" narrative
documentation chapter.
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/flash.rst | 36 | ||||
| -rw-r--r-- | docs/api/interfaces.rst | 1 |
2 files changed, 37 insertions, 0 deletions
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 |