summaryrefslogtreecommitdiff
path: root/docs/api/registry.rst
diff options
context:
space:
mode:
authorAmos Latteier <amos@latteier.com>2013-08-12 16:04:00 -0400
committerAmos Latteier <amos@latteier.com>2013-08-12 16:04:00 -0400
commit9d0643063615ef7ce54fe062461c5dbf92cde3b4 (patch)
treee2aa7d02cc479c811dca2544f6ed5d26277d8fc4 /docs/api/registry.rst
parent159ef62eecd4ec6c5759720ca04d7c18f1d5fd8b (diff)
downloadpyramid-9d0643063615ef7ce54fe062461c5dbf92cde3b4.tar.gz
pyramid-9d0643063615ef7ce54fe062461c5dbf92cde3b4.tar.bz2
pyramid-9d0643063615ef7ce54fe062461c5dbf92cde3b4.zip
Add documentation for creating and firing custom events. See issue #982.
Diffstat (limited to 'docs/api/registry.rst')
-rw-r--r--docs/api/registry.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/api/registry.rst b/docs/api/registry.rst
index db348495c..f96b23b68 100644
--- a/docs/api/registry.rst
+++ b/docs/api/registry.rst
@@ -29,6 +29,14 @@
This attribute is often accessed as ``request.registry.introspector`` in
a typical Pyramid application.
+ .. method:: notify(*events)
+
+ Fire one or more event. All event subscribers to the event(s)
+ will be notified. This method is often accessed as
+ ``request.registry.notify`` in Pyramid applications to fire
+ custom events. See :ref:`custom_events` for more information.
+
+
.. class:: Introspectable
.. versionadded:: 1.3