summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2010-07-28 03:00:58 +0000
committerChris McDonough <chrism@agendaless.com>2010-07-28 03:00:58 +0000
commitf077653f208f6f7c89c78c87c2abb0ea7031dbc0 (patch)
treeae5be691f2f19ccd98afa513738a2d424ecfe4e2 /docs/api
parentbe6f3b9ae06b31920d90744b20ccb7a8b4d9a278 (diff)
downloadpyramid-f077653f208f6f7c89c78c87c2abb0ea7031dbc0.tar.gz
pyramid-f077653f208f6f7c89c78c87c2abb0ea7031dbc0.tar.bz2
pyramid-f077653f208f6f7c89c78c87c2abb0ea7031dbc0.zip
- A ``repoze.bfg.events.subscriber`` decorator was added. This
decorator decorates module-scope functions, which are then treated as event listeners after a scan() is performed. See the Events narrative documentation chapter and the ``repoze.bfg.events`` module documentation for more information.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/events.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/api/events.rst b/docs/api/events.rst
index bb1ba1cf5..cad199be3 100644
--- a/docs/api/events.rst
+++ b/docs/api/events.rst
@@ -5,11 +5,19 @@
.. automodule:: repoze.bfg.events
- .. autoclass:: NewRequest
+Functions
+~~~~~~~~~
- .. autoclass:: NewResponse
+.. autofunction:: subscriber
- .. autoclass:: WSGIApplicationCreatedEvent
+Event Types
+~~~~~~~~~~~
+
+.. autoclass:: NewRequest
+
+.. autoclass:: NewResponse
+
+.. autoclass:: WSGIApplicationCreatedEvent
See :ref:`events_chapter` for more information about how to register
code which subscribes to these events.