chiark / gitweb /
py/tripe.py.in: Complete the docstring for `TripeCommandDispatcher'.
authorMark Wooding <mdw@distorted.org.uk>
Sun, 19 May 2013 18:24:34 +0000 (19:24 +0100)
committerMark Wooding <mdw@distorted.org.uk>
Sun, 19 May 2013 18:24:34 +0000 (19:24 +0100)
py/tripe.py.in

index c2b430b..fca3810 100644 (file)
@@ -663,7 +663,10 @@ class TripeCommandDispatcher (TripeConnection):
 
   The dispatcher also has a special response code of its own: CONNERR
   indicates that the connection failed and the command has therefore been
-  lost; the
+  lost.  This is sent to all outstanding commands when a connection error is
+  encountered: rather than a token list, it is accompanied by an exception
+  object which is the cause of the disconnection, which may be `None' if the
+  disconnection is expected (e.g., the direct result of a user request).
   """
 
   ## --- Infrastructure ---