summaryrefslogtreecommitdiff
path: root/docs/narr/router.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-01-27 23:06:55 -0500
committerChris McDonough <chrism@plope.com>2011-01-27 23:06:55 -0500
commit70acd25f40f32fc6cbb3b5d38a695b8982b52a31 (patch)
treeecaee199a36054a3664c39a7955cb441aaf6503d /docs/narr/router.rst
parent45c45f3ba6b688c988957056cb2c49883329dfe5 (diff)
downloadpyramid-70acd25f40f32fc6cbb3b5d38a695b8982b52a31.tar.gz
pyramid-70acd25f40f32fc6cbb3b5d38a695b8982b52a31.tar.bz2
pyramid-70acd25f40f32fc6cbb3b5d38a695b8982b52a31.zip
module name contractions
Diffstat (limited to 'docs/narr/router.rst')
-rw-r--r--docs/narr/router.rst24
1 files changed, 12 insertions, 12 deletions
diff --git a/docs/narr/router.rst b/docs/narr/router.rst
index 782098bac..11f84d4ea 100644
--- a/docs/narr/router.rst
+++ b/docs/narr/router.rst
@@ -29,10 +29,10 @@ processing?
#. The :term:`application registry` and the :term:`request` object
created in the last step are pushed on to the :term:`thread local`
stack that :app:`Pyramid` uses to allow the functions named
- :func:`pyramid.threadlocal.get_current_request` and
- :func:`pyramid.threadlocal.get_current_registry` to work.
+ :func:`~pyramid.threadlocal.get_current_request` and
+ :func:`~pyramid.threadlocal.get_current_registry` to work.
-#. A :class:`pyramid.events.NewRequest` :term:`event` is sent to any
+#. A :class:`~pyramid.events.NewRequest` :term:`event` is sent to any
subscribers.
#. If any :term:`route` has been defined within application
@@ -46,7 +46,7 @@ processing?
``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, the latter contains
- the :class:`pyramid.interfaces.IRoute` object representing the
+ the :class:`~pyramid.interfaces.IRoute` object representing the
route which matched. The root object associated with the route
found is also generated: if the :term:`route configuration` which
matched has an associated a ``factory`` argument, this factory is
@@ -74,7 +74,7 @@ processing?
they can be accessed via e.g. ``request.context`` within
:term:`view` code.
-#. A :class:`pyramid.events.ContextFound` :term:`event` is
+#. A :class:`~pyramid.events.ContextFound` :term:`event` is
sent to any subscribers.
#. :app:`Pyramid` looks up a :term:`view` callable using the
@@ -83,7 +83,7 @@ processing?
the context, the type of the request, and the value of the view
name, and any :term:`predicate` attributes applied to the view
configuration), :app:`Pyramid` raises a
- :class:`pyramid.exceptions.NotFound` exception, which is meant
+ :class:`~pyramid.exceptions.NotFound` exception, which is meant
to be caught by a surrounding exception handler.
#. If a view callable was found, :app:`Pyramid` attempts to call
@@ -97,14 +97,14 @@ processing?
security information attached to the context. If it returns
``True``, :app:`Pyramid` calls the view callable to obtain a
response. If it returns ``False``, it raises a
- :class:`pyramid.exceptions.Forbidden` exception, which is meant
+ :class:`~pyramid.exceptions.Forbidden` exception, which is meant
to be called by a surrounding exception handler.
#. If any exception was raised within a :term:`root factory`, by
:term:`traversal`, by a :term:`view callable` or by
:app:`Pyramid` itself (such as when it raises
- :class:`pyramid.exceptions.NotFound` or
- :class:`pyramid.exceptions.Forbidden`), the router catches the
+ :class:`~pyramid.exceptions.NotFound` or
+ :class:`~pyramid.exceptions.Forbidden`), the router catches the
exception, and attaches it to the request as the ``exception``
attribute. It then attempts to find a :term:`exception view` for
the exception that was caught. If it finds an exception view
@@ -116,15 +116,15 @@ processing?
successfully generated by a normal :term:`view callable` or an
:term:`exception view` callable. :app:`Pyramid` will attempt to execute
any :term:`response callback` functions attached via
- :meth:`pyramid.request.Request.add_response_callback`. A
- :class:`pyramid.events.NewResponse` :term:`event` is then sent to any
+ :meth:`~pyramid.request.Request.add_response_callback`. A
+ :class:`~pyramid.events.NewResponse` :term:`event` is then sent to any
subscribers. The response object's ``app_iter``, ``status``, and
``headerlist`` attributes are then used to generate a WSGI response. The
response is sent back to the upstream WSGI server.
#. :app:`Pyramid` will attempt to execute any :term:`finished
callback` functions attached via
- :meth:`pyramid.request.Request.add_finished_callback`.
+ :meth:`~pyramid.request.Request.add_finished_callback`.
#. The :term:`thread local` stack is popped.