[project @ Arch-1:robey@lag.net--2003-public%secsh--dev--1.0--patch-77]

docs for SubsystemHandler
add documentation to constructor for SubsystemHandler.

1 files changed, 12 insertions, 0 deletions

diff --git a/paramiko/transport.py b/paramiko/transport.py
index e017ac0c..9e25a966 100644
--- a/paramiko/transport.py
+++ b/paramiko/transport.py
@@ -142,6 +142,18 @@ class SubsystemHandler (threading.Thread):
     @since: ivysaur
     """
     def __init__(self, channel, name):
+        """
+        Create a new handler for a channel.  This is used by L{ServerInterface}
+        to start up a new handler when a channel requests this subsystem.  You
+        don't need to override this method, but if you do, be sure to pass the
+        C{channel} and C{name} parameters through to the original C{__init__}
+        method here.
+
+        @param channel: the channel associated with this subsystem request.
+        @type channel: L{Channel}
+        @param name: name of the requested subsystem.
+        @type name: str
+        """
         threading.Thread.__init__(self, target=self._run)
         self.__channel = channel
         self.__transport = channel.get_transport()