mostly docstrings

IPython/zmq/parallel/kernelstarter.py

@@ -35,7 +35,7 b' class KernelStarter(object):'
         msgtype = msg['msg_type']
         handler = self.handlers.get(msgtype, None)
         if handler is None:
-            self.downstream.send_multipart(raw_msg)
+            self.downstream.send_multipart(raw_msg, copy=False)
         else:
             handler(msg)
         
@@ -49,7 +49,7 b' class KernelStarter(object):'
         msgtype = msg['msg_type']
         handler = self.handlers.get(msgtype, None)
         if handler is None:
-            self.upstream.send_multipart(raw_msg)
+            self.upstream.send_multipart(raw_msg, copy=False)
         else:
             handler(msg)
     
@@ -58,7 +58,8 b' class KernelStarter(object):'
     #--------------------------------------------------------------------------
     
     def shutdown_request(self, msg):
-        
+        """"""
+        self.downstream.send_multipart(msg)
     
     #--------------------------------------------------------------------------
     # Kernel process management methods, from KernelManager:
@@ -202,7 +203,7 b' class KernelStarter(object):'
 
 
 def make_starter(up_addr, down_addr, *args, **kwargs):
-    """entry point script for launching a kernelstarter in a subprocess"""
+    """entry point function for launching a kernelstarter in a subprocess"""
     loop = ioloop.IOLoop.instance()
     ctx = zmq.Context()
     session = StreamSession()

IPython/zmq/parallel/streamsession.py

@@ -114,13 +114,6 b' class Message(object):'
 def msg_header(msg_id, msg_type, username, session):
     date=datetime.now().isoformat()
     return locals()
-    # return {
-    #     'msg_id' : msg_id,
-    #     'msg_type': msg_type,
-    #     'username' : username,
-    #     'session' : session
-    # }
-
 
 def extract_header(msg_or_header):
     """Given a message or header, return the header."""
@@ -179,8 +172,8 b' def serialize_object(obj, threshold=64e-6):'
     -------
     ('pmd', [bufs]) :
         where pmd is the pickled metadata wrapper,
-        bufs is a list of data buffers"""
-    # threshold is 100 B
+        bufs is a list of data buffers
+    """
     databuffers = []
     if isinstance(obj, (list, tuple)):
         clist = canSequence(obj)

IPython/zmq/tunnel.py

@@ -199,8 +199,13 b" def paramiko_tunnel(lport, rport, server, remoteip='127.0.0.1', keyfile=None, pa"
     This creates a tunnel redirecting `localhost:lport` to `remoteip:rport`,
     as seen from `server`.
     
+    If you are familiar with ssh tunnels, this creates the tunnel:
+    
+    ssh server -L localhost:lport:remoteip:rport
+    
     keyfile and password may be specified, but ssh config is checked for defaults.
     
+    
     Parameters
     ----------
     
@@ -244,8 +249,8 b' def _shutdown_process(p):'
         p.terminate()
 
 def _paramiko_tunnel(lport, rport, server, remoteip, keyfile=None, password=None):
-    """function for actually starting a paramiko tunnel, to be passed
-    to multiprocessing.Process(target=this).
+    """Function for actually starting a paramiko tunnel, to be passed
+    to multiprocessing.Process(target=this), and not called directly.
     """
     username, server, port = _split_server(server)
     client = paramiko.SSHClient()
@@ -285,16 +290,3 b' else:'
 __all__ = ['tunnel_connection', 'ssh_tunnel', 'openssh_tunnel', 'paramiko_tunnel', 'try_passwordless_ssh']
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-