summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2012-09-16 13:04:14 -0400
committerChris McDonough <chrism@plope.com>2012-09-16 13:04:14 -0400
commit7259e7e9f3d8f8eb70bcf782f622f8613f99a51d (patch)
tree01f8d4260cb0c30fd04773acb872e59a777d8989 /docs/api
parent5da21f623e0aa71106bd54bf0d199435f003b1d4 (diff)
downloadpyramid-7259e7e9f3d8f8eb70bcf782f622f8613f99a51d.tar.gz
pyramid-7259e7e9f3d8f8eb70bcf782f622f8613f99a51d.tar.bz2
pyramid-7259e7e9f3d8f8eb70bcf782f622f8613f99a51d.zip
make use_tweens=True the default, add some more tests
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/request.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/api/request.rst b/docs/api/request.rst
index 1718d0743..8af81cdac 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -161,7 +161,7 @@
request, the value of this attribute will be ``None``. See
:ref:`matched_route`.
- .. method:: invoke_subrequest(request, use_tweens=False)
+ .. method:: invoke_subrequest(request, use_tweens=True)
.. warning::
@@ -174,9 +174,9 @@
``True``, the request will be sent to the :term:`tween` in the tween
stack closest to the request ingress. If ``use_tweens`` is ``False``,
the request will be sent to the main router handler, and no tweens will
- be invoked. This isn't *actually* a method of the Request object; it's
- a callable added when the Pyramid router is invoked, or when a
- subrequest is invoked. This function also:
+ be invoked.
+
+ This function also:
- manages the threadlocal stack (so that
:func:`~pyramid.threadlocal.get_current_request` and
@@ -208,7 +208,11 @@
- Calls any :term:`finished callback` functions defined within the
request's lifetime.
- See also :ref:`subrequest_chapter`.
+ ``invoke_subrequest`` isn't *actually* a method of the Request object;
+ it's a callable added when the Pyramid router is invoked, or when a
+ subrequest is invoked. This means that it's not available for use on a
+ request provided by e.g. the ``pshell`` environment. For more
+ information, see :ref:`subrequest_chapter`.
.. automethod:: add_response_callback