summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael Merickel <michael@merickel.org>2018-11-04 13:25:32 -0600
committerMichael Merickel <michael@merickel.org>2018-11-04 13:25:32 -0600
commit44e7e63ac1f95d52bdd25c22c36efd820c059e35 (patch)
treee6062558dd3c5a4716f9cd521059f1621bc76457 /docs
parent6f0d73d6eea8064f1c5d9294beb7f7d64619071d (diff)
parentde5e4f40e0246d71ba5875c957281fb764da74dd (diff)
downloadpyramid-44e7e63ac1f95d52bdd25c22c36efd820c059e35.tar.gz
pyramid-44e7e63ac1f95d52bdd25c22c36efd820c059e35.tar.bz2
pyramid-44e7e63ac1f95d52bdd25c22c36efd820c059e35.zip
Merge branch 'pr/1639' into bare-route-prefix
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/urldispatch.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/narr/urldispatch.rst b/docs/narr/urldispatch.rst
index 52d64891c..701326fab 100644
--- a/docs/narr/urldispatch.rst
+++ b/docs/narr/urldispatch.rst
@@ -998,6 +998,24 @@ then only match if the URL path is ``/users/show``, and when the
:meth:`pyramid.request.Request.route_url` function is called with the route
name ``show_users``, it will generate a URL with that same path.
+To create a prefixed route that matches requests to the ``route_prefix``
+without a trailing slash set the route ``pattern`` to an empty string.
+
+.. code-block:: python
+ :linenos:
+
+ from pyramid.config import Configurator
+
+ def users_include(config):
+ config.add_route('show_users', '')
+
+ def main(global_config, **settings):
+ config = Configurator()
+ config.include(users_include, route_prefix='/users')
+
+The above configuration will match ``/users`` instead of ``/users/`` if a slash
+had been supplied to the :meth:`pyramid.config.Configurator.add_route` function.
+
Route prefixes are recursive, so if a callable executed via an include itself
turns around and includes another callable, the second-level route prefix will
be prepended with the first: