diff options
| -rw-r--r-- | HISTORY.rst | 2 | ||||
| -rw-r--r-- | docs/narr/hooks.rst | 2 | ||||
| -rw-r--r-- | docs/narr/viewconfig.rst | 2 | ||||
| -rw-r--r-- | docs/quick_tour.rst | 4 | ||||
| -rw-r--r-- | src/pyramid/config/routes.py | 5 | ||||
| -rw-r--r-- | src/pyramid/config/views.py | 15 |
6 files changed, 13 insertions, 17 deletions
diff --git a/HISTORY.rst b/HISTORY.rst index 4fd13119d..8b0028065 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -2530,7 +2530,7 @@ Features @view_config(abc=1) Similar features exist for ``add_route``, and ``add_subscriber``. See - "Adding A Third Party View, Route, or Subscriber Predicate" in the Hooks + "Adding A Custom View, Route, or Subscriber Predicate" in the Hooks chapter for more information. Note that changes made to support the above feature now means that only diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst index b6b103eb3..4632c2c0a 100644 --- a/docs/narr/hooks.rst +++ b/docs/narr/hooks.rst @@ -1446,7 +1446,7 @@ Likewise, a similar predicate can be used as a *route* predicate: config.add_route('name', '/foo', request_method='POST') Many other built-in predicates exists (``request_param``, and others). You can -add third-party predicates to the list of available predicates by using one of +add custom predicates to the list of available predicates by using one of :meth:`pyramid.config.Configurator.add_view_predicate` or :meth:`pyramid.config.Configurator.add_route_predicate`. The former adds a view predicate, the latter a route predicate. diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst index 3e596b030..5ba965def 100644 --- a/docs/narr/viewconfig.rst +++ b/docs/narr/viewconfig.rst @@ -524,7 +524,7 @@ configured view. in your app or by third-party packages extending Pyramid and registered via :meth:`pyramid.config.Configurator.add_view_predicate`. Use custom predicates when no set of predefined predicates do what you need. See - :ref:`view_and_route_predicates` for more information about third-party + :ref:`view_and_route_predicates` for more information about custom predicates. .. versionadded:: 1.4a1 diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst index fdd135331..511868ade 100644 --- a/docs/quick_tour.rst +++ b/docs/quick_tour.rst @@ -482,8 +482,8 @@ more to offer: .. seealso:: See also: :ref:`Quick Tutorial View Classes <qtut_view_classes>`, :ref:`Quick - Tutorial More View Classes <qtut_more_view_classes>`, and - :ref:`class_as_view`. + Tutorial More View Classes <qtut_more_view_classes>`, :ref:`class_as_view`, + :ref:`view_and_route_predicates`. Quick project startup with cookiecutters diff --git a/src/pyramid/config/routes.py b/src/pyramid/config/routes.py index cc3a87b2e..a508f69a4 100644 --- a/src/pyramid/config/routes.py +++ b/src/pyramid/config/routes.py @@ -306,8 +306,7 @@ class RoutesConfiguratorMixin(object): \*\*predicates - Pass extra keyword parameters to use custom or third-party predicates - registered via + Pass extra keyword parameters to use custom predicates registered via :meth:`pyramid.config.Configurator.add_route_predicate`. More than one custom predicate can be used at the same time. See :ref:`view_and_route_predicates` for more information about @@ -323,7 +322,7 @@ class RoutesConfiguratorMixin(object): 'Configurator.add_route is deprecated as of Pyramid 1.5. ' 'Use "config.add_route_predicate" and use the registered ' 'route predicate as a predicate argument to add_route ' - 'instead. See "Adding A Third Party View, Route, or ' + 'instead. See "Adding A Custom View, Route, or ' 'Subscriber Predicate" in the "Hooks" chapter of the ' 'documentation for more information.' ), diff --git a/src/pyramid/config/views.py b/src/pyramid/config/views.py index 20f20b5e8..bbc4fc5bc 100644 --- a/src/pyramid/config/views.py +++ b/src/pyramid/config/views.py @@ -729,22 +729,19 @@ class ViewsConfiguratorMixin(object): .. deprecated:: 1.5 This value should be a sequence of references to custom - predicate callables. Use custom predicates when no set of - predefined predicates do what you need. Custom predicates - can be combined with predefined predicates as necessary. - Each custom predicate callable should accept two arguments: + predicate callables. Each custom predicate callable + should accept two arguments: ``context`` and ``request`` and should return either ``True`` or ``False`` after doing arbitrary evaluation of - the context and/or the request. The ``predicates`` argument - to this method and the ability to register third-party view - predicates via + the context and/or the request. The ability to register + custom view predicates via :meth:`pyramid.config.Configurator.add_view_predicate` obsoletes this argument, but it is kept around for backwards compatibility. \*\*view_options - Pass extra keyword parameters to use custom or third-party predicates + Pass extra keyword parameters to use custom predicates or set a value for a view deriver. See :meth:`pyramid.config.Configurator.add_view_predicate` and :meth:`pyramid.config.Configurator.add_view_deriver`. See @@ -771,7 +768,7 @@ class ViewsConfiguratorMixin(object): 'Configurator.add_view is deprecated as of Pyramid 1.5. ' 'Use "config.add_view_predicate" and use the registered ' 'view predicate as a predicate argument to add_view ' - 'instead. See "Adding A Third Party View, Route, or ' + 'instead. See "Adding A Custom View, Route, or ' 'Subscriber Predicate" in the "Hooks" chapter of the ' 'documentation for more information.' ), |
