diff options
| author | Marius Gedminas <marius@gedmin.as> | 2010-12-29 00:36:21 +0200 |
|---|---|---|
| committer | Marius Gedminas <marius@gedmin.as> | 2010-12-29 00:36:21 +0200 |
| commit | 133f1231b1288e20777b56c82d5c5b7730010eab (patch) | |
| tree | 759dabb7f9304ba4aed22476abdb346ab123f31c /docs | |
| parent | 87e5443d655b745ba7a5a675bdd52027a2240d11 (diff) | |
| download | pyramid-133f1231b1288e20777b56c82d5c5b7730010eab.tar.gz pyramid-133f1231b1288e20777b56c82d5c5b7730010eab.tar.bz2 pyramid-133f1231b1288e20777b56c82d5c5b7730010eab.zip | |
Show the method signatures of pop_flash/peek_flash.
The narrative referred to popping messages from a particular queue, but
the code examples didn't show how to indicate which queue you were
interested in, leaving the reader a bit confused.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/narr/flash.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/narr/flash.rst b/docs/narr/flash.rst index d009da4fb..71c6cf305 100644 --- a/docs/narr/flash.rst +++ b/docs/narr/flash.rst @@ -63,6 +63,8 @@ queue and return it for use. To pop a particular queue of messages from the flash object, use the session object's ``pop_flash`` method. +.. method:: pop_flash(queue='') + .. code-block:: python :linenos: @@ -93,6 +95,8 @@ Once one or more messages has been added to a flash queue by the at that queue. Unlike ``session.pop_flash``, the queue is not popped from flash storage. +.. method:: peek_flash(queue='') + .. code-block:: python :linenos: |