diff options
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. |