From 9d0643063615ef7ce54fe062461c5dbf92cde3b4 Mon Sep 17 00:00:00 2001
From: Amos Latteier <amos@latteier.com>
Date: Mon, 12 Aug 2013 16:04:00 -0400
Subject: Add documentation for creating and firing custom events. See issue
 #982.

---
 docs/api/registry.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'docs/api')

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
-- 
cgit v1.2.3