diff options
| author | Chris McDonough <chrism@agendaless.com> | 2010-09-08 05:01:26 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2010-09-08 05:01:26 +0000 |
| commit | 51b2f9457a852956342518683f5c13d9da394b52 (patch) | |
| tree | c2531709dd3ceef7bb273ed68a37249998de63fe /docs/narr | |
| parent | 49eccc078d13e1b6104f201f7e11ac31d8e024cf (diff) | |
| download | pyramid-51b2f9457a852956342518683f5c13d9da394b52.tar.gz pyramid-51b2f9457a852956342518683f5c13d9da394b52.tar.bz2 pyramid-51b2f9457a852956342518683f5c13d9da394b52.zip | |
- The ``repoze.bfg.interfaces`` API documentation page is now rendered
via ``repoze.sphinx.autointerface``.
- The URL Dispatch narrative chapter now refers to the ``interfaces``
chapter to explain the API of an ``IRoute`` object.
- ``tests_require`` now includes ``repoze.sphinx.autointerface`` as a
dependency.
Diffstat (limited to 'docs/narr')
| -rw-r--r-- | docs/narr/urldispatch.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst index 6a5a24c81..2f1a235a7 100644 --- a/docs/narr/urldispatch.rst +++ b/docs/narr/urldispatch.rst @@ -657,7 +657,8 @@ current :term:`request` object. The ``info`` dictionary has a number of contained values: ``match`` is a dictionary: it represents the arguments matched in the URL by the route. ``route`` is an object representing the route which was -matched. +matched (see ``IRoute`` in :ref:`interfaces_module` for the API of +such a route object). ``info['match']`` is useful when predicates need access to the route match. For example: @@ -749,6 +750,9 @@ The above predicate, when added to a number of route configurations ensures that the year match argument is '2010' if and only if the route name is 'ymd', 'ym', or 'y'. +See also ``IRoute`` in :ref:`interfaces_module` for more API +documentation about a route object. + Route Matching -------------- |