Michael Merickel
2018-10-10 4cc3a67060f22bb11d037bd44a24112efca6d507
fix up the docs
3 files modified
94 ■■■■■ changed files
docs/narr/viewconfig.rst 31 ●●●● patch | view | raw | blame | history
pyramid/config/routes.py 16 ●●●●● patch | view | raw | blame | history
pyramid/config/views.py 47 ●●●● patch | view | raw | blame | history
docs/narr/viewconfig.rst
@@ -285,6 +285,23 @@
  are just developing stock Pyramid applications. Pay no attention to the man
  behind the curtain.
``accept``
  A :term:`media type` that will be matched against the ``Accept`` HTTP request header.
  If this value is specified, it must be a specific media type such as ``text/html`` or ``text/html;level=1``.
  If the media type is acceptable by the ``Accept`` header of the request, or if the ``Accept`` header isn't set at all in the request, this predicate will match.
  If this does not match the ``Accept`` header of the request, view matching continues.
  If ``accept`` is not specified, the ``HTTP_ACCEPT`` HTTP header is not taken into consideration when deciding whether or not to invoke the associated view callable.
  The ``accept`` argument is technically not a predicate and does not support wrapping with :func:`pyramid.config.not_`.
  See :ref:`accept_content_negotiation` for more information.
  .. versionchanged:: 1.10
      Specifying a media range is deprecated and will be removed in :app:`Pyramid` 2.0.
      Use explicit media types to avoid any ambiguities in content negotiation.
``exception_only``
  When this value is ``True``, the ``context`` argument must be a subclass of
@@ -343,20 +360,6 @@
  of being invoked if no other route was matched. This is when the
  request/context pair found via :term:`resource location` does not indicate it
  matched any configured route.
``accept``
  A :term:`media type` that will be matched against the ``Accept`` HTTP request header.
  If this value is specified, it must be a specific media type, such as ``text/html``.
  If the media type is acceptable by the ``Accept`` header of the request, or if the ``Accept`` header isn't set at all in the request, this predicate will match.
  If this does not match the ``Accept`` header of the request, view matching continues.
  If ``accept`` is not specified, the ``HTTP_ACCEPT`` HTTP header is not taken into consideration when deciding whether or not to invoke the associated view callable.
  See :ref:`accept_content_negotiation` for more information.
  .. versionchanged:: 1.10
      Media ranges such as ``text/*`` will now raise :class:`pyramid.exceptions.ConfigurationError`.
      Previously these values had undefined behavior based on the version of WebOb being used and was never fully supported.
``request_type``
  This value should be an :term:`interface` that the :term:`request` must
pyramid/config/routes.py
@@ -228,17 +228,21 @@
        accept
          A :term:`media type` that will be matched against the ``Accept``
          HTTP request header.  This value may be a specific media type such
          as ``text/html``, or a list of the same. If the media type is
          acceptable by the ``Accept`` header of the request, or if the
          ``Accept`` header isn't set at all in the request, this predicate
          will match. If this does not match the ``Accept`` header of the
          request, route matching continues.
          HTTP request header.  If this value is specified, it may be a
          specific media type such as ``text/html``, or a list of the same.
          If the media type is acceptable by the ``Accept`` header of the
          request, or if the ``Accept`` header isn't set at all in the request,
          this predicate will match. If this does not match the ``Accept``
          header of the request, route matching continues.
          If ``accept`` is not specified, the ``HTTP_ACCEPT`` HTTP header is
          not taken into consideration when deciding whether or not to select
          the route.
          Unlike the ``accept`` argument to
          :meth:`pyramid.config.Configurator.add_view`, this value is
          strictly a predicate and supports :func:`pyramid.config.not_`.
          .. versionchanged:: 1.10
              Specifying a media range is deprecated due to changes in WebOb
pyramid/config/views.py
@@ -542,6 +542,31 @@
          very useful for 'civilians' who are just developing stock Pyramid
          applications. Pay no attention to the man behind the curtain.
        accept
          A :term:`media type` that will be matched against the ``Accept``
          HTTP request header.  If this value is specified, it must be a
          specific media type such as ``text/html`` or ``text/html;level=1``.
          If the media type is acceptable by the ``Accept`` header of the
          request, or if the ``Accept`` header isn't set at all in the request,
          this predicate will match. If this does not match the ``Accept``
          header of the request, view matching continues.
          If ``accept`` is not specified, the ``HTTP_ACCEPT`` HTTP header is
          not taken into consideration when deciding whether or not to invoke
          the associated view callable.
          The ``accept`` argument is technically not a predicate and does
          not support wrapping with :func:`pyramid.config.not_`.
          See :ref:`accept_content_negotiation` for more information.
          .. versionchanged:: 1.10
              Specifying a media range is deprecated and will be removed in
              :app:`Pyramid` 2.0. Use explicit media types to avoid any
              ambiguities in content negotiation.
        exception_only
          .. versionadded:: 1.8
@@ -673,28 +698,6 @@
          value must match the header value.  Whether or not the value
          represents a header name or a header name/value pair, the
          case of the header name is not significant.
        accept
          A :term:`media type` that will be matched against the ``Accept``
          HTTP request header.  This value must be a specific media type such
          as ``text/html`` or ``text/html;level=1``. If the media type is
          acceptable by the ``Accept`` header of the request, or if the
          ``Accept`` header isn't set at all in the request, this predicate
          will match. If this does not match the ``Accept`` header of the
          request, view matching continues.
          If ``accept`` is not specified, the ``HTTP_ACCEPT`` HTTP header is
          not taken into consideration when deciding whether or not to invoke
          the associated view callable.
          See :ref:`accept_content_negotiation` for more information.
          .. versionchanged:: 1.10
              Specifying a media range is deprecated and will be removed in
              :app:`Pyramid` 2.0. Use explicit media types to avoid any
              ambiguities in content negotiation.
        path_info