From 2e6905e15221691e645e5ff4ba0378a6d9438c29 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@plope.com>
Date: Mon, 25 Oct 2010 23:09:02 -0400
Subject: add httpexceptions docs

---
 docs/narr/webob.rst | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

(limited to 'docs/narr/webob.rst')

diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst
index 82416a44d..b3bec882e 100644
--- a/docs/narr/webob.rst
+++ b/docs/narr/webob.rst
@@ -309,20 +309,23 @@ default to anything, though if you subclass ``Response`` and set
 Exceptions
 ++++++++++
 
-To facilitate error responses like 404 Not Found, the module
-``webob.exc`` contains classes for each kind of error response.  These
-include boring but appropriate error bodies.
-
-Each class is named ``webob.exc.HTTP*``, where ``*`` is the reason for
-the error.  For instance, ``webob.exc.HTTPNotFound``.  It subclasses
-``Response``, so you can manipulate the instances in the same way.  A
-typical example is:
+To facilitate error responses like ``404 Not Found``, the module
+:mod:`webob.exc` contains classes for each kind of error response.
+These include boring but appropriate error bodies.  The exceptions
+exposed by this module, when used under :mod:`pyramid`, should be
+imported from the :mod:`pyramid.httpexceptions` "facade" module.
+
+Each class is named ``pyramid.httpexceptions.HTTP*``, where ``*`` is
+the reason for the error.  For instance,
+``pyramid.httpexceptions.HTTPNotFound``.  It subclasses ``Response``,
+so you can manipulate the instances in the same way.  A typical
+example is:
 
 .. ignore-next-block
 .. code-block:: python
 
-    from webob.exc import HTTPNotFound
-    from webob.exc import HTTPMovedPermanently
+    from pyramid.httpexceptions import HTTPNotFound
+    from pyramid.httpexceptions import HTTPMovedPermanently
 
     response = HTTPNotFound('There is no such resource')
     # or:
@@ -336,8 +339,8 @@ You can use this like:
 .. code-block:: python
    :linenos:
 
-   from webob.exc import HTTPException
-   from webob.exc import HTTPNotFound
+   from pyramid.httpexceptions import HTTPException
+   from pyramid.httpexceptions import HTTPNotFound
 
    def aview(request):
        try:
-- 
cgit v1.2.3