- General documentation freshening which takes imperative

  configuration into account in more places and uses glossary
  references more liberally.

1 files changed, 23 insertions, 21 deletions

diff --git a/repoze/bfg/events.py b/repoze/bfg/events.py
index 14e47ca3f..75a5aec5a 100644
--- a/repoze/bfg/events.py
+++ b/repoze/bfg/events.py
@@ -6,19 +6,20 @@ from repoze.bfg.interfaces import INewResponse
 from repoze.bfg.interfaces import IWSGIApplicationCreatedEvent
 
 class NewRequest(object):
-    """ An instance of this class is emitted as an event whenever
-    repoze.bfg begins to process a new request.  The instance has an
-    attribute, ``request``, which is the request object.  This class
-    implements the ``repoze.bfg.interfaces.INewRequest`` interface."""
+    """ An instance of this class is emitted as an :term:`event`
+    whenever repoze.bfg begins to process a new request.  The instance
+    has an attribute, ``request``, which is a :term:`request` object.
+    This class implements the ``repoze.bfg.interfaces.INewRequest``
+    interface."""
     implements(INewRequest)
     def __init__(self, request):
         self.request = request
 
 class NewResponse(object):
-    """ An instance of this class is emitted as an event whenever any
-    repoze.bfg view returns a response..  The instance has an
-    attribute, ``response``, which is the response object returned by
-    the view.  This class implements the
+    """ An instance of this class is emitted as an :term:`event`
+    whenever any repoze.bfg view returns a :term:`response`..  The
+    instance has an attribute, ``response``, which is the response
+    object returned by the view.  This class implements the
     ``repoze.bfg.interfaces.INewResponse`` interface."""
     implements(INewResponse)
     def __init__(self, response):
@@ -26,23 +27,24 @@ class NewResponse(object):
 
 class AfterTraversal(object):
     implements(IAfterTraversal)
-    """ An instance of this class is emitted as an event after the
-    repoze.bfg router performs traversal (but before any view code is
-    executed).  The instance has an attribute, ``request``, which is
-    the request object returned by the view.  Notably, the request
-    object will have an attribute named ``context``, which is the
-    context that will be provided to the view which will eventually be
-    called, as well as other attributes defined by the traverser.
-    This class implements the
-    ``repoze.bfg.interfaces.IAfterTraversal`` interface."""
+    """ An instance of this class is emitted as an :term:`event` after
+    the repoze.bfg :term:`router` performs traversal but before any
+    view code is executed.  The instance has an attribute,
+    ``request``, which is the request object generated by
+    :mod:`repoze.bfg`.  Notably, the request object will have an
+    attribute named ``context``, which is the context that will be
+    provided to the view which will eventually be called, as well as
+    other attributes defined by the traverser.  This class implements
+    the ``repoze.bfg.interfaces.IAfterTraversal`` interface."""
     def __init__(self, request):
         self.request = request
     
 class WSGIApplicationCreatedEvent(object):    
-    """ An instance of this class is emitted as an event whenever a
-    ``repoze.bfg`` application starts.  The instance has an attribute,
-    ``app``, which is an instance of the ``repoze.bfg.router.Router``
-    class that will handle WSGI requests.  This class implements the
+    """ An instance of this class is emitted as an :term:`event` when
+    the ``make_wsgi_app`` method of a :term:`Configurator` is called).
+    The instance has an attribute, ``app``, which is an instance of
+    the ``repoze.bfg.router.Router`` class that will handle WSGI
+    requests.  This class implements the
     ``repoze.bfg.interfaces.IWSGIApplicationCreatedEvent`` interface."""
     implements(IWSGIApplicationCreatedEvent)
     def __init__(self, app):