Merge pull request #12922 from Carreau/doc-3

DOC: Some more autoformatting of docstrings.

IPython/__init__.py

@@ -68,20 +68,19 b' version_info = release.version_info'
 
 def embed_kernel(module=None, local_ns=None, **kwargs):
     """Embed and start an IPython kernel in a given scope.
-    
+
     If you don't want the kernel to initialize the namespace
     from the scope of the surrounding function,
     and/or you want to load full IPython configuration,
     you probably want `IPython.start_kernel()` instead.
-    
+
     Parameters
     ----------
     module : types.ModuleType, optional
         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.
@@ -99,26 +98,25 b' def embed_kernel(module=None, local_ns=None, **kwargs):'
 
 def start_ipython(argv=None, **kwargs):
     """Launch a normal IPython instance (as opposed to embedded)
-    
+
     `IPython.embed()` puts a shell in a particular calling scope,
     such as a function or method for debugging purposes,
     which is often not desirable.
-    
+
     `start_ipython()` does full, regular IPython initialization,
     including loading startup files, configuration, etc.
     much of which is skipped by `embed()`.
-    
+
     This is a public API method, and will survive implementation changes.
-    
+
     Parameters
     ----------
-    
     argv : list or None, optional
         If unspecified or None, IPython will parse command-line options from sys.argv.
         To prevent any command-line parsing, pass an empty list: `argv=[]`.
     user_ns : dict, optional
         specify this dictionary to initialize the IPython user namespace with particular values.
-    kwargs : various, optional
+    **kwargs : various, optional
         Any other kwargs will be passed to the Application constructor,
         such as `config`.
     """
@@ -127,24 +125,23 b' def start_ipython(argv=None, **kwargs):'
 
 def start_kernel(argv=None, **kwargs):
     """Launch a normal IPython kernel instance (as opposed to embedded)
-    
+
     `IPython.embed_kernel()` puts a shell in a particular calling scope,
     such as a function or method for debugging purposes,
     which is often not desirable.
-    
+
     `start_kernel()` does full, regular IPython initialization,
     including loading startup files, configuration, etc.
     much of which is skipped by `embed()`.
-    
+
     Parameters
     ----------
-    
     argv : list or None, optional
         If unspecified or None, IPython will parse command-line options from sys.argv.
         To prevent any command-line parsing, pass an empty list: `argv=[]`.
     user_ns : dict, optional
         specify this dictionary to initialize the IPython user namespace with particular values.
-    kwargs : various, optional
+    **kwargs : various, optional
         Any other kwargs will be passed to the Application constructor,
         such as `config`.
     """

IPython/core/application.py

@@ -254,7 +254,7 b' class BaseIPythonApplication(Application):'
     
     def excepthook(self, etype, evalue, tb):
         """this is sys.excepthook after init_crashhandler
-        
+
         set self.verbose_crash=True to use our full crashhandler, instead of
         a regular traceback with a short message (crash_handler_lite)
         """

IPython/core/autocall.py

@@ -41,9 +41,9 b' class IPyAutocall(object):'
     
     def set_ip(self, ip):
         """ Will be used to set _ip point to current ipython instance b/f call
-        
+
         Override this method if you don't want this to happen.
-        
+
         """
         self._ip = ip
 

IPython/core/compilerop.py

@@ -118,12 +118,12 b' class CachingCompiler(codeop.Compile):'
         Parameters
         ----------
         raw_code : str
-          The raw cell code.
+            The raw cell code.
         transformed_code : str
-          The executable Python source code to cache and compile.
+            The executable Python source code to cache and compile.
         number : int
-          A number which forms part of the code's name. Used for the execution
-          counter.
+            A number which forms part of the code's name. Used for the execution
+            counter.
 
         Returns
         -------
@@ -137,12 +137,12 b' class CachingCompiler(codeop.Compile):'
         Parameters
         ----------
         transformed_code : str
-          The executable Python source code to cache and compile.
+            The executable Python source code to cache and compile.
         number : int
-          A number which forms part of the code's name. Used for the execution
-          counter.
+            A number which forms part of the code's name. Used for the execution
+            counter.
         raw_code : str
-          The raw code before transformation, if None, set to `transformed_code`.
+            The raw code before transformation, if None, set to `transformed_code`.
 
         Returns
         -------

IPython/core/completer.py

@@ -431,9 +431,9 b' def _deduplicate_completions(text: str, completions: _IC)-> _IC:'
 
     Parameters
     ----------
-    text: str
+    text : str
         text that should be completed.
-    completions: Iterator[Completion]
+    completions : Iterator[Completion]
         iterator over the completions to deduplicate
 
     Yields
@@ -474,9 +474,9 b' def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:'
 
     Parameters
     ----------
-    text: str
+    text : str
         text that should be completed.
-    completions: Iterator[Completion]
+    completions : Iterator[Completion]
         iterator over the completions to rectify
 
     Notes
@@ -763,13 +763,13 b' def match_dict_keys(keys: List[Union[str, bytes, Tuple[Union[str, bytes]]]], pre'
 
     Parameters
     ----------
-    keys:
+    keys
         list of keys in dictionary currently being completed.
-    prefix:
+    prefix
         Part of the text already typed by the user. E.g. `mydict[b'fo`
-    delims:
+    delims
         String of delimiters to consider when finding the current key.
-    extra_prefix: optional
+    extra_prefix : optional
         Part of the text already typed in multi-key index cases. E.g. for
         `mydict['foo', "bar", 'b`, this would be `('foo', 'bar')`.
 
@@ -993,7 +993,7 b' def _formatparamchildren(parameter) -> str:'
 
     Parameters
     ----------
-    parameter:
+    parameter
         Jedi's function `Param`
 
     Returns
@@ -1013,7 +1013,7 b' def _make_signature(completion)-> str:'
 
     Parameters
     ----------
-    completion: jedi.Completion
+    completion : jedi.Completion
         object does not complete a function type
 
     Returns
@@ -1854,9 +1854,9 b' class IPCompleter(Completer):'
 
         Parameters
         ----------
-        text:str
+        text : str
             Full text of the current input, multi line string.
-        offset:int
+        offset : int
             Integer representing the position of the cursor in ``text``. Offset
             is 0-based indexed.
 

IPython/core/crashhandler.py

@@ -101,25 +101,19 b' class CrashHandler(object):'
 
         Parameters
         ----------
-        app :  Application
+        app : Application
             A running :class:`Application` instance, which will be queried at
             crash time for internal information.
-
         contact_name : str
             A string with the name of the person to contact.
-
         contact_email : str
             A string with the email address of the contact.
-
         bug_tracker : str
             A string with the URL for your project's bug tracker.
-
         show_crash_traceback : bool
             If false, don't print the crash traceback on stderr, only generate
             the on-disk report
-
-        Non-argument instance attributes:
-
+        Non-argument instance attributes
         These instances contain some non-argument attributes which allow for
         further customization of the crash handler's behavior. Please see the
         source for further details.

IPython/core/debugger.py

@@ -109,7 +109,6 b' class Tracer(object):'
 
         Parameters
         ----------
-
         colors : str, optional
             The name of the color scheme to use, it must be one of IPython's
             valid color schemes.  If not given, the function will default to

IPython/core/display_functions.py

@@ -62,7 +62,7 b' def publish_display_data(data, metadata=None, source=None, *, transient=None, **'
         Unused.
     transient : dict, keyword-only
         A dictionary of transient data, such as display_id.
-        """
+    """
     from IPython.core.interactiveshell import InteractiveShell
 
     display_pub = InteractiveShell.instance().display_pub
@@ -133,12 +133,11 b' def display('
     clear : bool, optional
         Should the output area be cleared before displaying anything? If True,
         this will wait for additional output before clearing. [default: False]
-    kwargs: additional keyword-args, optional
+    **kwargs : additional keyword-args, optional
         Additional keyword-arguments are passed through to the display publisher.
 
     Returns
     -------
-
     handle: DisplayHandle
         Returns a handle on updatable displays for use with :func:`update_display`,
         if `display_id` is given. Returns :any:`None` if no `display_id` is given
@@ -146,7 +145,6 b' def display('
 
     Examples
     --------
-
     >>> class Json(object):
     ...     def __init__(self, json):
     ...         self.json = json
@@ -185,12 +183,10 b' def display('
 
     See Also
     --------
-
     :func:`update_display`
 
     Notes
     -----
-
     In Python, objects can declare their textual representation using the
     `__repr__` method. IPython expands on this idea and allows objects to declare
     other, rich representations including:
@@ -300,15 +296,13 b' def update_display(obj, *, display_id, **kwargs):'
 
     Parameters
     ----------
-
-    obj:
+    obj
         The object with which to update the display
-    display_id: keyword-only
+    display_id : keyword-only
         The id of the display to update
 
     See Also
     --------
-
     :func:`display`
     """
     kwargs['update'] = True
@@ -343,10 +337,9 b' class DisplayHandle(object):'
 
         Parameters
         ----------
-
-        obj:
+        obj
             object to display
-        **kwargs:
+        **kwargs
             additional keyword arguments passed to display
         """
         display(obj, display_id=self.display_id, **kwargs)
@@ -356,10 +349,9 b' class DisplayHandle(object):'
 
         Parameters
         ----------
-
-        obj:
+        obj
             object to display
-        **kwargs:
+        **kwargs
             additional keyword arguments passed to update_display
         """
         update_display(obj, display_id=self.display_id, **kwargs)