summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBert JW Regeer <xistence@0x58.com>2016-04-11 14:32:45 -0600
committerBert JW Regeer <xistence@0x58.com>2016-04-11 14:32:45 -0600
commitc8a9a4a279b7568657c5dc3e8f2ad8da31be5890 (patch)
tree3e9d745ce6c8f3497b883e6b5229eec6ada490d9
parente224ffabfc70beadd583629d325e598ffd286361 (diff)
parent0da7b0de590b835d6d7df361394b8bf70797f566 (diff)
downloadpyramid-c8a9a4a279b7568657c5dc3e8f2ad8da31be5890.tar.gz
pyramid-c8a9a4a279b7568657c5dc3e8f2ad8da31be5890.tar.bz2
pyramid-c8a9a4a279b7568657c5dc3e8f2ad8da31be5890.zip
Merge pull request #2475 from stevepiercy/feature/BeforeTraversal
update BeforeTraversal event in router.rst
-rw-r--r--docs/narr/router.rst29
1 files changed, 14 insertions, 15 deletions
diff --git a/docs/narr/router.rst b/docs/narr/router.rst
index d4c0cc885..e45e6f4a8 100644
--- a/docs/narr/router.rst
+++ b/docs/narr/router.rst
@@ -41,27 +41,26 @@ request enters a :app:`Pyramid` application through to the point that
user-defined :term:`route` matches the current WSGI environment. The
:term:`router` passes the request as an argument to the mapper.
-#. If any route matches, the route mapper adds attributes to the request:
- ``matchdict`` and ``matched_route`` attributes are added to the request
- object. The former contains a dictionary representing the matched dynamic
- elements of the request's ``PATH_INFO`` value, and the latter contains the
+#. If any route matches, the route mapper adds the attributes ``matchdict``
+ and ``matched_route`` to the request 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.
-
- A :class:`~pyramid.events.BeforeTraversal` :term:`event` is sent to any
+
+#. 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.
+#. Continuing, if any route matches, the root object associated with the found
+ route is generated. If the :term:`route configuration` which matched has an
+ associated ``factory`` argument, then 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
+ However, if no route matches, and if a ``root_factory`` argument was passed
to the :term:`Configurator` constructor, that callable is used to generate
- 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 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 :app:`Pyramid` router calls a "traverser" function with the root object
and the request. The traverser function attempts to traverse the root