More explicitly discussed properties of HTTPException objects.

Michael Merickel

2011-08-25 5bcab687562b667e3e1ceb8ca9075e524c064d3a

More explicitly discussed properties of HTTPException objects.

 pyramid/httpexceptions.py

@@ -62,7 +62,10 @@
        * 505 - HTTPVersionNotSupported
        * 507 - HTTPInsufficientStorage

Each HTTP exception has the following attributes:
HTTP exceptions are also :term:`response` objects, thus they accept most of
the same parameters that can be passed to a regular
:class:`~pyramid.response.Response`. Each HTTP exception also has the
following attributes:

   ``code``
       the HTTP status code for the exception
@@ -86,7 +89,8 @@
       the explanation and further detail provided in the
       message.

Each HTTP exception accepts the following parameters:
Each HTTP exception accepts the following parameters, any others will
be forwarded to its :class:`~pyramid.response.Response` superclass:

   ``detail``
     a plain-text override of the default ``detail``
@@ -102,6 +106,10 @@
     a ``string.Template`` object containing a content fragment in HTML
     that frames the explanation and further detail

   ``body``
     a string that will override the ``body_template`` and be used as the
     body of the response.

Substitution of response headers into template values is always performed.
Substitution of WSGI environment values is performed if a ``request`` is
passed to the exception's constructor.