summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorBert JW Regeer <bertjw@regeer.org>2016-04-10 22:18:21 -0600
committerBert JW Regeer <bertjw@regeer.org>2016-04-10 22:18:21 -0600
commit5b918737fb361584d820893fc82c6b898ae1fc69 (patch)
tree8fc9cbb416890bc22366d290d1a7bb5cb98542c6 /docs/narr
parent3f34aa05a48e5d9ae7b43f717b5ad9061effb08c (diff)
downloadpyramid-5b918737fb361584d820893fc82c6b898ae1fc69.tar.gz
pyramid-5b918737fb361584d820893fc82c6b898ae1fc69.tar.bz2
pyramid-5b918737fb361584d820893fc82c6b898ae1fc69.zip
Update router documentation
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/router.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/narr/router.rst b/docs/narr/router.rst
index e02142e6e..d4c0cc885 100644
--- a/docs/narr/router.rst
+++ b/docs/narr/router.rst
@@ -46,16 +46,22 @@ request enters a :app:`Pyramid` application through to the point that
object. The former contains a dictionary representing the matched dynamic
elements of the request's ``PATH_INFO`` value, and the latter contains the
:class:`~pyramid.interfaces.IRoute` object representing the route which
- matched. The root object associated with the route found is also generated:
+ matched.
+
+ A :class:`~pyramid.events.BeforeTraversal` :term:`event` is sent to any
+ subscribers.
+
+ The root object associated with the route found is also generated:
if the :term:`route configuration` which matched has an associated
``factory`` argument, this factory is used to generate the root object,
otherwise a default :term:`root factory` is used.
#. If a route match was *not* found, and a ``root_factory`` argument was passed
to the :term:`Configurator` constructor, that callable is used to generate
- the root object. If the ``root_factory`` argument passed to the
- Configurator constructor was ``None``, a default root factory is used to
- generate a root object.
+ the root object after a :class:`~pyramid.events.BeforeTraversal`
+ :term:`event` is sent to any subscribers. If the ``root_factory`` argument
+ passed to the Configurator constructor was ``None``, a default root factory
+ is used to generate a root object.
#. The :app:`Pyramid` router calls a "traverser" function with the root object
and the request. The traverser function attempts to traverse the root