summaryrefslogtreecommitdiff
path: root/docs/narr/events.rst
diff options
context:
space:
mode:
authorCasey Duncan <casey.duncan@gmail.com>2011-01-15 23:44:44 -0700
committerCasey Duncan <casey.duncan@gmail.com>2011-01-15 23:44:44 -0700
commit1e11161515d00b72787c0ca4615d791d68b63c1a (patch)
tree0fc4575fa8592ce8f664d7489579082e37059692 /docs/narr/events.rst
parent4d4173ff808b33a3c29ee5874751d4da25ddcca0 (diff)
downloadpyramid-1e11161515d00b72787c0ca4615d791d68b63c1a.tar.gz
pyramid-1e11161515d00b72787c0ca4615d791d68b63c1a.tar.bz2
pyramid-1e11161515d00b72787c0ca4615d791d68b63c1a.zip
promote event listener config topics to subheadings. Topic formatting is too distracting imo
Diffstat (limited to 'docs/narr/events.rst')
-rw-r--r--docs/narr/events.rst62
1 files changed, 32 insertions, 30 deletions
diff --git a/docs/narr/events.rst b/docs/narr/events.rst
index 06b30883f..90966a730 100644
--- a/docs/narr/events.rst
+++ b/docs/narr/events.rst
@@ -38,49 +38,51 @@ you'll need to use the
need to use the :func:`pyramid.events.subscriber` decorator to decorate a
function found via a :term:`scan`.
-.. topic:: Configuring an Event Listener Imperatively
+Configuring an Event Listener Imperatively
+------------------------------------------
- You can imperatively configure a subscriber function to be called
- for some event type via the
- :meth:`pyramid.config.Configurator.add_subscriber`
- method (see also :term:`Configurator`):
+You can imperatively configure a subscriber function to be called
+for some event type via the
+:meth:`pyramid.config.Configurator.add_subscriber`
+method (see also :term:`Configurator`):
- .. code-block:: python
- :linenos:
+.. code-block:: python
+ :linenos:
- from pyramid.events import NewRequest
+ from pyramid.events import NewRequest
- from subscribers import mysubscriber
+ from subscribers import mysubscriber
- # "config" below is assumed to be an instance of a
- # pyramid.config.Configurator object
+ # "config" below is assumed to be an instance of a
+ # pyramid.config.Configurator object
- config.add_subscriber(mysubscriber, NewRequest)
+ config.add_subscriber(mysubscriber, NewRequest)
- The first argument to
- :meth:`pyramid.config.Configurator.add_subscriber` is the
- subscriber function (or a :term:`dotted Python name` which refers
- to a subscriber callable); the second argument is the event type.
+The first argument to
+:meth:`pyramid.config.Configurator.add_subscriber` is the
+subscriber function (or a :term:`dotted Python name` which refers
+to a subscriber callable); the second argument is the event type.
-.. topic:: Configuring an Event Listener Using a Decorator
+Configuring an Event Listener Using a Decorator
+-----------------------------------------------
- You can configure a subscriber function to be called for some event
- type via the :func:`pyramid.events.subscriber` function.
+You can configure a subscriber function to be called for some event
+type via the :func:`pyramid.events.subscriber` function.
- .. code-block:: python
- :linenos:
+.. code-block:: python
+ :linenos:
- from pyramid.events import NewRequest
- from pyramid.events import subscriber
+ from pyramid.events import NewRequest
+ from pyramid.events import subscriber
- @subscriber(NewRequest)
- def mysubscriber(event):
- event.request.foo = 1
+ @subscriber(NewRequest)
+ def mysubscriber(event):
+ event.request.foo = 1
- When the :func:`pyramid.subscriber` decorator is used a
- :term:`scan` must be performed against the package containing the
- decorated function for the decorator to have any effect. See
- :func:`pyramid.subscriber` for more information.
+When the :func:`pyramid.subscriber` decorator is used a
+:term:`scan` must be performed against the package containing the
+decorated function for the decorator to have any effect. See
+:func:`pyramid.subscriber` for more information.
.. note:: You can also configure an event listener via ZCML. See
:ref:`zcml_event_listener`.