diff options
Diffstat (limited to 'repoze')
| -rw-r--r-- | repoze/bfg/events.py | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/repoze/bfg/events.py b/repoze/bfg/events.py index 75a5aec5a..1c9ca174c 100644 --- a/repoze/bfg/events.py +++ b/repoze/bfg/events.py @@ -7,20 +7,20 @@ from repoze.bfg.interfaces import IWSGIApplicationCreatedEvent class NewRequest(object): """ 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.""" + whenever :mod:`repoze.bfg` begins to process a new request. The + instance has an attribute, ``request``, which is a :term:`request` + object. This class implements the + :class:`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 :term:`event` - whenever any repoze.bfg view returns a :term:`response`.. The - instance has an attribute, ``response``, which is the response + whenever any :mod:`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.""" + :class:`repoze.bfg.interfaces.INewResponse` interface.""" implements(INewResponse) def __init__(self, response): self.response = response @@ -28,24 +28,25 @@ class NewResponse(object): class AfterTraversal(object): implements(IAfterTraversal) """ 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, + the :mod:`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.""" + the :class:`repoze.bfg.interfaces.IAfterTraversal` interface.""" def __init__(self, request): self.request = request class WSGIApplicationCreatedEvent(object): """ 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.""" + the :meth:`repoze.bfg.configuration.Configurator.make_wsgi_app` is + called. The instance has an attribute, ``app``, which is an + instance of the :class:`repoze.bfg.router.Router` class that will + handle WSGI requests. This class implements the + :class:`repoze.bfg.interfaces.IWSGIApplicationCreatedEvent` + interface.""" implements(IWSGIApplicationCreatedEvent) def __init__(self, app): self.app = app |