diff options
| author | Steve Piercy <web@stevepiercy.com> | 2016-04-24 15:42:34 -0700 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2016-04-24 15:42:34 -0700 |
| commit | b5fcc452c364284648aae4c0ce061b3bac711cd0 (patch) | |
| tree | 79207d83a1396f531d7665f4a3615f76d6aca211 /docs/narr | |
| parent | 1a6e20fbc048a03bee8b8be8955788861c4ed9ed (diff) | |
| download | pyramid-b5fcc452c364284648aae4c0ce061b3bac711cd0.tar.gz pyramid-b5fcc452c364284648aae4c0ce061b3bac711cd0.tar.bz2 pyramid-b5fcc452c364284648aae4c0ce061b3bac711cd0.zip | |
Allow Sphinx doctests to run and pass with `make doctest SPHINXBUILD=$VENV/bin/sphinx-build`.
- TODO: two tests in `docs/narr/hooks.rst`
Diffstat (limited to 'docs/narr')
| -rw-r--r-- | docs/narr/sessions.rst | 45 |
1 files changed, 28 insertions, 17 deletions
diff --git a/docs/narr/sessions.rst b/docs/narr/sessions.rst index 7e961f5e8..a1319e45f 100644 --- a/docs/narr/sessions.rst +++ b/docs/narr/sessions.rst @@ -260,19 +260,28 @@ added to the flash queue, and empties the queue. .. method:: pop_flash(queue='') ->>> request.session.flash('info message') ->>> request.session.pop_flash() -['info message'] +.. testsetup:: + + from pyramid import testing + request = testing.DummyRequest() + +.. doctest:: + + >>> request.session.flash('info message') + >>> request.session.pop_flash() + ['info message'] Calling ``session.pop_flash()`` again like above without a corresponding call to ``session.flash()`` will return an empty list, because the queue has already been popped. ->>> request.session.flash('info message') ->>> request.session.pop_flash() -['info message'] ->>> request.session.pop_flash() -[] +.. doctest:: + + >>> request.session.flash('info message') + >>> request.session.pop_flash() + ['info message'] + >>> request.session.pop_flash() + [] .. index:: single: session.peek_flash @@ -287,15 +296,17 @@ flash storage. .. method:: peek_flash(queue='') ->>> request.session.flash('info message') ->>> request.session.peek_flash() -['info message'] ->>> request.session.peek_flash() -['info message'] ->>> request.session.pop_flash() -['info message'] ->>> request.session.peek_flash() -[] +.. doctest:: + + >>> request.session.flash('info message') + >>> request.session.peek_flash() + ['info message'] + >>> request.session.peek_flash() + ['info message'] + >>> request.session.pop_flash() + ['info message'] + >>> request.session.peek_flash() + [] .. index:: single: preventing cross-site request forgery attacks |
