diff options
| author | Chris McDonough <chrism@agendaless.com> | 2010-09-14 12:11:44 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2010-09-14 12:11:44 +0000 |
| commit | 70f1cda02f9acccf7ee1c8ad1a7ade36fba10dba (patch) | |
| tree | af2236494ee485c40575bb728d5755de1d579ace /docs | |
| parent | 7edbac105bdde5cf27ea397343c748ec24b11bd8 (diff) | |
| download | pyramid-70f1cda02f9acccf7ee1c8ad1a7ade36fba10dba.tar.gz pyramid-70f1cda02f9acccf7ee1c8ad1a7ade36fba10dba.tar.bz2 pyramid-70f1cda02f9acccf7ee1c8ad1a7ade36fba10dba.zip | |
- The ``add_route`` method of a Configurator now accepts a
``pregenerator`` argument. The pregenerator for the resulting route
is called by ``route_url`` in order to adjust the set of arguments
passed to it by the user for special purposes, such as Pylons
'subdomain' support. It will influence the URL returned by
``route_url``. See the ``repoze.bfg.interfaces.IRoutePregenerator``
interface for more information.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/interfaces.rst | 1 | ||||
| -rw-r--r-- | docs/glossary.rst | 9 |
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst index 974ab2ae9..be2de2c7f 100644 --- a/docs/api/interfaces.rst +++ b/docs/api/interfaces.rst @@ -23,4 +23,5 @@ Other Interfaces .. autointerface:: IRoute + .. autointerface:: IRoutePregenerator diff --git a/docs/glossary.rst b/docs/glossary.rst index 158af2230..e3b46c1f6 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -784,3 +784,12 @@ Glossary A user-defined callback executed by the :term:`router` unconditionally at the very end of request processing . See :ref:`using_finished_callbacks`. + + pregenerator + A pregenerator is a function associated by a developer with a + :term:`route`. It is called by :func:`repoze.bfg.url.route_url` + in order to adjust the set of arguments passed to it by the user + for special purposes. It will influence the URL returned by + ``route_url``. See + :class:`repoze.bfg.interfaces.IRoutePregenerator` for more + information. |