# HG changeset patch
# User Martin Bornhold <martin@rhodecode.com>
# Date 2016-10-17 08:45:13
# Node ID b4758185d8e6ebfa6fcc82bcf2dfe1fe8339d0c5
# Parent  1a069e4a21755d40b4667495d5485cd4e3557bb1

events: Add comments to the subcriber classes.

diff --git a/rhodecode/subscribers.py b/rhodecode/subscribers.py
--- a/rhodecode/subscribers.py
+++ b/rhodecode/subscribers.py
@@ -78,6 +78,9 @@ def scan_repositories_if_enabled(event):
 
 
 class Subscriber(object):
+    """
+    Base class for subscribers to the pyramid event system.
+    """
     def __call__(self, event):
         self.run(event)
 
@@ -86,6 +89,12 @@ class Subscriber(object):
 
 
 class AsyncSubscriber(Subscriber):
+    """
+    Subscriber that handles the execution of events in a separate task to not
+    block the execution of the code which triggers the event. It puts the
+    received events into a queue from which the worker process takes them in
+    order.
+    """
     def __init__(self):
         self._stop = False
         self._eventq = Queue.Queue()
@@ -113,6 +122,10 @@ class AsyncSubscriber(Subscriber):
 
 
 class AsyncSubprocessSubscriber(AsyncSubscriber):
+    """
+    Subscriber that uses the subprocess32 module to execute a command if an
+    event is received. Events are handled asynchronously.
+    """
 
     def __init__(self, cmd, timeout=None):
         super(AsyncSubprocessSubscriber, self).__init__()