Added note about message categories.

supersexy · Nov 4, 2014 · 2738f75 · 2738f75
1 parent 5490a54
commit 2738f75
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/basic-usage.rst b/docs/basic-usage.rst
@@ -299,3 +299,15 @@ applications.
    :param container: If true, will output a complete
                      ``<div class="container">`` element, otherwise just the
                      messages each wrapped in a ``<div>``.
+
+Note that for this functionality to work properly, flashing messages must be
+categorized with a valid bootstrap alert category (one of ``success``,
+``info``, ``warning``, ``danger``).
+
+.. highlight:: python
+
+Example::
+
+    flash('Operation failed', 'danger')
+
+.. highlight:: jinja