DOC: Autoreformat all docstrings.

This reformat all docstrings in ipykernel to conform to numpydoc.

Author: Carreau

ipykernel/connect.py

@@ -36,7 +36,7 @@ def get_connection_file(app=None):
 
 def find_connection_file(filename='kernel-*.json', profile=None):
     """DEPRECATED: find a connection file, and return its absolute path.
-    
+
     THIS FUNCTION IS DEPRECATED. Use jupyter_client.find_connection_file instead.
 
     Parameters
@@ -80,7 +80,7 @@ def find_connection_file(filename='kernel-*.json', profile=None):
 
 def _find_connection_file(connection_file, profile=None):
     """Return the absolute path for a connection file
-    
+
     - If nothing specified, return current Kernel's connection file
     - If profile specified, show deprecation warning about finding connection files in profiles
     - Otherwise, call jupyter_client.find_connection_file

ipykernel/datapub.py

@@ -38,7 +38,6 @@ def publish_data(self, data):
 
         Parameters
         ----------
-
         data : dict
             The data to be published. Think of it as a namespace.
         """
@@ -60,7 +59,6 @@ def publish_data(data):
 
     Parameters
     ----------
-
     data : dict
         The data to be published. Think of it as a namespace.
     """

ipykernel/embed.py

@@ -23,8 +23,7 @@ def embed_kernel(module=None, local_ns=None, **kwargs):
         The module to load into IPython globals (default: caller)
     local_ns : dict, optional
         The namespace to load into IPython user namespace (default: caller)
-
-    kwargs : various, optional
+    **kwargs : various, optional
         Further keyword args are relayed to the IPKernelApp constructor,
         allowing configuration of the Kernel.  Will only have an effect
         on the first embed_kernel call for a given process.

ipykernel/iostream.py

@@ -50,10 +50,9 @@ def __init__(self, socket, pipe=False):
 
         Parameters
         ----------
-
-        socket: zmq.PUB Socket
+        socket : zmq.PUB Socket
             the socket on which messages will be sent.
-        pipe: bool
+        pipe : bool
             Whether this process should listen for IOPub messages
             piped from subprocesses.
         """

ipykernel/jsonutil.py

@@ -50,13 +50,11 @@ def encode_images(format_dict):
 
     Parameters
     ----------
-
     format_dict : dict
         A dictionary of display data keyed by mime-type
 
     Returns
     -------
-
     format_dict : dict
         A copy of the same dictionary,
         but binary image data ('image/png', 'image/jpeg' or 'application/pdf')
@@ -87,10 +85,9 @@ def json_clean(obj):
     Returns
     -------
     out : object
-
-      A version of the input which will not cause an encoding error when
-      encoded as JSON.  Note that this function does not *encode* its inputs,
-      it simply sanitizes it so that there will be no encoding errors later.
+        A version of the input which will not cause an encoding error when
+        encoded as JSON.  Note that this function does not *encode* its inputs,
+        it simply sanitizes it so that there will be no encoding errors later.
 
     """
     # types that are 'atomic' and ok in json as-is.

ipykernel/kernelapp.py

@@ -527,10 +527,10 @@ def init_shell(self):
     def configure_tornado_logger(self):
         """ Configure the tornado logging.Logger.
 
-            Must set up the tornado logger or else tornado will call
-            basicConfig for the root logger which makes the root logger
-            go to the real sys.stderr instead of the capture streams.
-            This function mimics the setup of logging.basicConfig.
+        Must set up the tornado logger or else tornado will call
+        basicConfig for the root logger which makes the root logger
+        go to the real sys.stderr instead of the capture streams.
+        This function mimics the setup of logging.basicConfig.
         """
         logger = logging.getLogger('tornado')
         handler = logging.StreamHandler()

ipykernel/kernelspec.py

@@ -28,16 +28,13 @@ def make_ipkernel_cmd(mod='ipykernel_launcher', executable=None, extra_arguments
     ----------
     mod : str, optional (default 'ipykernel')
         A string of an IPython module whose __main__ starts an IPython kernel
-
     executable : str, optional (default sys.executable)
         The Python executable to use for the kernel process.
-
     extra_arguments : list, optional
         A list of extra arguments to pass when executing the launch code.
 
     Returns
     -------
-
     A Popen command list
     """
     if executable is None:
@@ -61,10 +58,10 @@ def get_kernel_dict(extra_arguments=None):
 
 def write_kernel_spec(path=None, overrides=None, extra_arguments=None):
     """Write a kernel spec directory to `path`
-    
+
     If `path` is not specified, a temporary directory is created.
     If `overrides` is given, the kernelspec JSON is updated before writing.
-    
+
     The path to the kernelspec is always returned.
     """
     if path is None:
@@ -92,33 +89,31 @@ def write_kernel_spec(path=None, overrides=None, extra_arguments=None):
 def install(kernel_spec_manager=None, user=False, kernel_name=KERNEL_NAME, display_name=None,
             prefix=None, profile=None, env=None):
     """Install the IPython kernelspec for Jupyter
-    
+
     Parameters
     ----------
-    
-    kernel_spec_manager: KernelSpecManager [optional]
+    kernel_spec_manager : KernelSpecManager [optional]
         A KernelSpecManager to use for installation.
         If none provided, a default instance will be created.
-    user: bool [default: False]
+    user : bool [default: False]
         Whether to do a user-only install, or system-wide.
-    kernel_name: str, optional
+    kernel_name : str, optional
         Specify a name for the kernelspec.
         This is needed for having multiple IPython kernels for different environments.
-    display_name: str, optional
+    display_name : str, optional
         Specify the display name for the kernelspec
-    profile: str, optional
+    profile : str, optional
         Specify a custom profile to be loaded by the kernel.
-    prefix: str, optional
+    prefix : str, optional
         Specify an install prefix for the kernelspec.
         This is needed to install into a non-default location, such as a conda/virtual-env.
-    env: dict, optional
+    env : dict, optional
         A dictionary of extra environment variables for the kernel.
         These will be added to the current environment variables before the
         kernel is started
 
     Returns
     -------
-    
     The path where the kernelspec was installed.
     """
     if kernel_spec_manager is None:

ipykernel/parentpoller.py

@@ -55,7 +55,6 @@ def __init__(self, interrupt_handle=None, parent_handle=None):
         interrupt_handle : HANDLE (int), optional
             If provided, the program will generate a Ctrl+C event when this
             handle is signaled.
-
         parent_handle : HANDLE (int), optional
             If provided, the program will terminate immediately when this
             handle is signaled.

ipykernel/pickleutil.py

@@ -67,7 +67,7 @@ def interactive(f):
 
 def use_dill():
     """use dill to expand serialization support
-    
+
     adds support for object methods and closures to serialization.
     """
     # import dill causes most of the magic
@@ -91,7 +91,7 @@ def use_dill():
 
 def use_cloudpickle():
     """use cloudpickle to expand serialization support
-    
+
     adds support for object methods and closures to serialization.
     """
     import cloudpickle
@@ -118,18 +118,16 @@ def use_cloudpickle():
 class CannedObject(object):
     def __init__(self, obj, keys=[], hook=None):
         """can an object for safe pickling
-        
+
         Parameters
-        ==========
-        
-        obj:
+        ----------
+        obj
             The object to be canned
-        keys: list (optional)
+        keys : list (optional)
             list of attribute names that will be explicitly canned / uncanned
-        hook: callable (optional)
+        hook : callable (optional)
             An optional extra callable,
             which can do additional processing of the uncanned object.
-        
         large data may be offloaded into the buffers list,
         used for zero-copy transfers.
         """
@@ -304,7 +302,7 @@ class CannedMemoryView(CannedBytes):
 
 def _import_mapping(mapping, original=None):
     """import any string-keys in a type mapping
-    
+
     """
     log = get_logger()
     log.debug("Importing canning map")
@@ -322,7 +320,7 @@ def _import_mapping(mapping, original=None):
 
 def istype(obj, check):
     """like isinstance(obj, check), but strict
-    
+
     This won't catch subclasses.
     """
     if isinstance(check, tuple):

ipykernel/pylab/backend_inline.py

@@ -25,13 +25,13 @@ def show(close=None, block=None):
     Parameters
     ----------
     close : bool, optional
-      If true, a ``plt.close('all')`` call is automatically issued after
-      sending all the figures. If this is set, the figures will entirely
-      removed from the internal list of figures.
+        If true, a ``plt.close('all')`` call is automatically issued after
+        sending all the figures. If this is set, the figures will entirely
+        removed from the internal list of figures.
     block : Not used.
-      The `block` parameter is a Matplotlib experimental parameter.
-      We accept it in the function signature for compatibility with other
-      backends.
+        The `block` parameter is a Matplotlib experimental parameter.
+        We accept it in the function signature for compatibility with other
+        backends.
     """
     if close is None:
         close = InlineBackend.instance().close_figures
@@ -158,7 +158,6 @@ def configure_inline_support(shell, backend):
     Parameters
     ----------
     shell : InteractiveShell instance
-
     backend : matplotlib backend
     """
     # If using our svg payload backend, register the post-execution