diff options
| -rw-r--r-- | CHANGES.txt | 3 | ||||
| -rw-r--r-- | docs/narr/router.png | bin | 0 -> 168209 bytes | |||
| -rw-r--r-- | docs/narr/router.rst | 10 |
3 files changed, 9 insertions, 4 deletions
diff --git a/CHANGES.txt b/CHANGES.txt index 9ead6e65e..65365ba65 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -13,6 +13,9 @@ Documentation - Describe "request-only" view calling conventions inside the urldispatch narrative chapter, where it's most helpful. +- Add a diagram which explains the operation of the BFG router to the + "Router" narrative chapter. + Features -------- diff --git a/docs/narr/router.png b/docs/narr/router.png Binary files differnew file mode 100644 index 000000000..fc4407e81 --- /dev/null +++ b/docs/narr/router.png diff --git a/docs/narr/router.rst b/docs/narr/router.rst index a86e5267c..55df2936c 100644 --- a/docs/narr/router.rst +++ b/docs/narr/router.rst @@ -3,6 +3,8 @@ How :mod:`repoze.bfg` Processes A Request ========================================= +.. image:: router.png + Once a :mod:`repoze.bfg` application is up and running, it is ready to accept requests and return responses. @@ -65,11 +67,11 @@ processing? a :term:`view name` as well as other ancillary information. #. The request is decorated with various names returned from the - traverser (such as ``context``, ``view_name``, ``matchdict``, and - so forth), so they can be accessed via e.g. ``request.context`` - within :term:`view` code. + traverser (such as ``context``, ``view_name``, and so forth), so + they can be accessed via e.g. ``request.context`` within + :term:`view` code. -#. If an :term:`authentication policy` is in use, :mod:`repoze.bfg` +#. If an :term:`authorization policy` is in use, :mod:`repoze.bfg` passes the context, the request, and the view_name to a function which determines whether the view being asked for can be executed by the requesting user, based on credential information in the |
