event doc updates

.gitignore

@@ -2,3 +2,4 @@ dist
 *.pyc
 pynsq.egg-info
 build
+docs/_build

docs/async_conn.rst

@@ -0,0 +1,6 @@
+:class:`AsyncConn` -- a connection to nsqd
+==========================================
+
+.. autoclass:: nsq.AsyncConn
+  :members:
+  :inherited-members:

docs/index.rst

@@ -17,6 +17,7 @@ Contents:
    :maxdepth: 2
 
    message
+   async_conn
    reader
    writer
    legacy_reader

docs/message.rst

@@ -3,3 +3,4 @@
 
 .. autoclass:: nsq.Message
   :members:
+  :inherited-members:

docs/reader.rst

@@ -9,3 +9,4 @@ Consumers
 
 .. autoclass:: nsq.Reader
   :members:
+  :inherited-members:

docs/writer.rst

@@ -9,3 +9,4 @@ Producers
 
 .. autoclass:: nsq.Writer
   :members:
+  :inherited-members:

nsq/async.py

@@ -30,8 +30,22 @@ class AsyncConn(EventedMixin):
     """
     Low level object representing a TCP connection to nsqd.
     
-    When a message on this connection is requeued, it can calculate the delay automatically
-    by an increasing multiple of ``requeue_delay``.
+    When a message on this connection is requeued and the requeue delay has not been specified,
+    it calculates the delay automatically by an increasing multiple of ``requeue_delay``.
+    
+    Generates the following events that can be listened to with :meth:`nsq.AsyncConn.on`:
+    
+     * ``connect``
+     * ``close``
+     * ``error``
+     * ``identify``
+     * ``identify_response``
+     * ``heartbeat``
+     * ``ready``
+     * ``message``
+     * ``response``
+     * ``backoff``
+     * ``resume``
     
     :param host: the host to connect to
     
@@ -47,7 +61,7 @@ class AsyncConn(EventedMixin):
     :param tls_v1: enable TLS v1 encryption (requires nsqd 0.2.22+)
     
     :param tls_options: dictionary of options to pass to `ssl.wrap_socket() 
-        <http://docs.python.org/2/library/ssl.html#ssl.wrap_socket>`_ as **kwargs
+        <http://docs.python.org/2/library/ssl.html#ssl.wrap_socket>`_ as ``**kwargs``
     
     :param snappy: enable Snappy stream compression (requires nsqd 0.2.23+)
     

nsq/message.py

@@ -8,11 +8,17 @@ class Message(EventedMixin):
     If you want to perform asynchronous message processing use the
     :meth:`nsq.Message.enable_async` method, pass the message around,
     and respond using the appropriate instance method.
-
-    NOTE: A calling a message's .finish() and .requeue() methods positively and
-    negatively impact the backoff state, respectively.  However, sending the
-    backoff=False keyword argument to .requeue() is considered neutral and
-    will not impact backoff state.
+    
+    Generates the following events that can be listened to with :meth:`nsq.Message.on`:
+    
+     * ``finish``
+     * ``requeue``
+     * ``touch``
+
+    NOTE: A calling a message's :meth:`nsq.Message.finish()` and :meth:`nsq.Message.requeue()`
+    methods positively and negatively impact the backoff state, respectively.  However,
+    sending the ``backoff=False`` keyword argument to :meth:`nsq.Message.requeue()` is
+    considered neutral and will not impact backoff state.
 
     :param id: the ID of the message
     :type id: string