Merge pull request #13388 from Carreau/reformat-docstring

Reformat docstring and v8 what's new.

IPython/core/completer.py

@@ -462,7 +462,7 b' def _deduplicate_completions(text: str, completions: _IC)-> _IC:'
             seen.add(new_text)
 
 
-def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:
+def rectify_completions(text: str, completions: _IC, *, _debug: bool = False) -> _IC:
     """
     Rectify a set of completions to all have the same ``start`` and ``end``
 
@@ -479,6 +479,8 b' def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:'
         text that should be completed.
     completions : Iterator[Completion]
         iterator over the completions to rectify
+    _debug : bool
+        Log failed completion
 
     Notes
     -----
@@ -1128,16 +1130,22 b' class IPCompleter(Completer):'
             secondary optional dict for completions, to
             handle cases (such as IPython embedded inside functions) where
             both Python scopes are visible.
-        use_readline : bool, optional
-            DEPRECATED, ignored since IPython 6.0, will have no effects
+        config : Config
+            traitlet's config object
+        **kwargs
+            passed to super class unmodified.
         """
 
         self.magic_escape = ESC_MAGIC
         self.splitter = CompletionSplitter()
 
         # _greedy_changed() depends on splitter and readline being defined:
-        Completer.__init__(self, namespace=namespace, global_namespace=global_namespace,
-                            config=config, **kwargs)
+        super().__init__(
+            namespace=namespace,
+            global_namespace=global_namespace,
+            config=config,
+            **kwargs
+        )
 
         # List where completion matches will be stored
         self.matches = []
@@ -2055,9 +2063,9 b' class IPCompleter(Completer):'
 
         Parameters
         ----------
-        cursor_line :
+        cursor_line
             Index of the line the cursor is on. 0 indexed.
-        cursor_pos :
+        cursor_pos
             Position of the cursor in the current line/line_buffer/text. 0
             indexed.
         line_buffer : optional, str

IPython/core/crashhandler.py

@@ -32,6 +32,8 b' from IPython.utils.py3compat import input'
 
 from IPython.core.release import __version__ as version
 
+from typing import Optional
+
 #-----------------------------------------------------------------------------
 # Code
 #-----------------------------------------------------------------------------
@@ -95,8 +97,15 b' class CrashHandler(object):'
     message_template = _default_message_template
     section_sep = '\n\n'+'*'*75+'\n\n'
 
-    def __init__(self, app, contact_name=None, contact_email=None,
-                 bug_tracker=None, show_crash_traceback=True, call_pdb=False):
+    def __init__(
+        self,
+        app,
+        contact_name: Optional[str] = None,
+        contact_email: Optional[str] = None,
+        bug_tracker: Optional[str] = None,
+        show_crash_traceback: bool = True,
+        call_pdb: bool = False,
+    ):
         """Create a new crash handler
 
         Parameters
@@ -113,10 +122,15 b' class CrashHandler(object):'
         show_crash_traceback : bool
             If false, don't print the crash traceback on stderr, only generate
             the on-disk report
-        Non-argument instance attributes
+        call_pdb
+            Whether to call pdb on crash
+
+        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.
+
         """
         self.crash_report_fname = "Crash_report_%s.txt" % app.name
         self.app = app

IPython/core/debugger.py

@@ -798,7 +798,6 b' class Pdb(OldPdb):'
 
     def break_anywhere(self, frame):
         """
-
         _stop_in_decorator_internals is overly restrictive, as we may still want
         to trace function calls, so we need to also update break_anywhere so
         that is we don't `stop_here`, because of debugger skip, we may still
@@ -820,8 +819,6 b' class Pdb(OldPdb):'
         """
         Utility to tell us whether we are in a decorator internal and should stop.
 
-
-
         """
 
         # if we are disabled don't skip

IPython/core/display.py

@@ -826,15 +826,19 b' class Image(DisplayObject):'
         data : unicode, str or bytes
             The raw image data or a URL or filename to load the data from.
             This always results in embedded image data.
+
         url : unicode
             A URL to download the data from. If you specify `url=`,
             the image data will not be embedded unless you also specify `embed=True`.
+
         filename : unicode
             Path to a local file to load the data from.
             Images from a file are always embedded.
+
         format : unicode
             The format of the image data (png/jpeg/jpg/gif). If a filename or URL is given
             for format will be inferred from the filename extension.
+
         embed : bool
             Should the image data be embedded using a data URI (True) or be
             loaded using an <img> tag. Set this to True if you want the image
@@ -844,10 +848,13 b' class Image(DisplayObject):'
             default value is `False`.
 
             Note that QtConsole is not able to display images if `embed` is set to `False`
+
         width : int
             Width in pixels to which to constrain the image in html
+
         height : int
             Height in pixels to which to constrain the image in html
+
         retina : bool
             Automatically set the width and height to half of the measured
             width and height.
@@ -855,10 +862,13 b' class Image(DisplayObject):'
             from image data.
             For non-embedded images, you can just set the desired display width
             and height directly.
+
         unconfined : bool
             Set unconfined=True to disable max-width confinement of the image.
+
         metadata : dict
             Specify extra metadata to attach to the image.
+
         alt : unicode
             Alternative text for the image, for use by screen readers.
 
@@ -1067,12 +1077,15 b' class Video(DisplayObject):'
         data : unicode, str or bytes
             The raw video data or a URL or filename to load the data from.
             Raw data will require passing ``embed=True``.
+
         url : unicode
             A URL for the video. If you specify ``url=``,
             the image data will not be embedded.
+
         filename : unicode
             Path to a local file containing the video.
             Will be interpreted as a local URL unless ``embed=True``.
+
         embed : bool
             Should the video be embedded using a data URI (True) or be
             loaded using a <video> tag (False).
@@ -1083,15 +1096,19 b' class Video(DisplayObject):'
             Local files can be displayed with URLs without embedding the content, via::
 
                 Video('./video.mp4')
+
         mimetype : unicode
             Specify the mimetype for embedded videos.
             Default will be guessed from file extension, if available.
+
         width : int
             Width in pixels to which to constrain the video in HTML.
             If not supplied, defaults to the width of the video.
+
         height : int
             Height in pixels to which to constrain the video in html.
             If not supplied, defaults to the height of the video.
+
         html_attributes : str
             Attributes for the HTML ``<video>`` block.
             Default: ``"controls"`` to get video controls.
@@ -1221,7 +1238,6 b' def set_matplotlib_close(close=True):'
 
         use `matplotlib_inline.backend_inline.set_matplotlib_close()`
 
-
     Set whether the inline backend closes all figures automatically or not.
 
     By default, the inline backend used in the IPython Notebook will close all

IPython/core/formatters.py

@@ -433,6 +433,7 b' class BaseFormatter(Configurable):'
         ----------
         typ : type or '__module__.__name__' string for a type
             The class of the object that will be formatted using `func`.
+
         func : callable
             A callable for computing the format data.
             `func` will be called with the object to be formatted,
@@ -474,8 +475,10 b' class BaseFormatter(Configurable):'
         type_module : str
             The full dotted name of the module the type is defined in, like
             ``numpy``.
+
         type_name : str
             The name of the type (the class name), like ``dtype``
+
         func : callable
             A callable for computing the format data.
             `func` will be called with the object to be formatted,

IPython/core/getipython.py

@@ -16,7 +16,7 b''
 
 def get_ipython():
     """Get the global InteractiveShell instance.
-    
+
     Returns None if no InteractiveShell instance is registered.
     """
     from IPython.core.interactiveshell import InteractiveShell

IPython/core/history.py

@@ -195,12 +195,12 b' class HistoryAccessor(HistoryAccessorBase):'
         Parameters
         ----------
         profile : str
-          The name of the profile from which to open history.
+            The name of the profile from which to open history.
         hist_file : str
-          Path to an SQLite history database stored by IPython. If specified,
-          hist_file overrides profile.
+            Path to an SQLite history database stored by IPython. If specified,
+            hist_file overrides profile.
         config : :class:`~traitlets.config.loader.Config`
-          Config object. hist_file can also be set through this.
+            Config object. hist_file can also be set through this.
         """
         # We need a pointer back to the shell for various tasks.
         super(HistoryAccessor, self).__init__(**traits)
@@ -227,7 +227,7 b' class HistoryAccessor(HistoryAccessorBase):'
         Parameters
         ----------
         profile : str
-          The name of a profile which has a history file.
+            The name of a profile which has a history file.
         """
         return Path(locate_profile(profile)) / "history.sqlite"
 
@@ -271,13 +271,13 b' class HistoryAccessor(HistoryAccessorBase):'
         Parameters
         ----------
         sql : str
-          Any filtering expressions to go after SELECT ... FROM ...
+            Any filtering expressions to go after SELECT ... FROM ...
         params : tuple
-          Parameters passed to the SQL query (to replace "?")
+            Parameters passed to the SQL query (to replace "?")
         raw, output : bool
-          See :meth:`get_range`
+            See :meth:`get_range`
         latest : bool
-          Select rows with max (session, line)
+            Select rows with max (session, line)
 
         Returns
         -------
@@ -305,23 +305,21 b' class HistoryAccessor(HistoryAccessorBase):'
 
         Parameters
         ----------
-
         session : int
             Session number to retrieve.
 
         Returns
         -------
-
         session_id : int
-           Session ID number
+            Session ID number
         start : datetime
-           Timestamp for the start of the session.
+            Timestamp for the start of the session.
         end : datetime
-           Timestamp for the end of the session, or None if IPython crashed.
+            Timestamp for the end of the session, or None if IPython crashed.
         num_cmds : int
-           Number of commands run, or None if IPython crashed.
+            Number of commands run, or None if IPython crashed.
         remark : unicode
-           A manually set description.
+            A manually set description.
         """
         query = "SELECT * from sessions where session == ?"
         return self.db.execute(query, (session,)).fetchone()
@@ -343,13 +341,13 b' class HistoryAccessor(HistoryAccessorBase):'
         Parameters
         ----------
         n : int
-          The number of lines to get
+            The number of lines to get
         raw, output : bool
-          See :meth:`get_range`
+            See :meth:`get_range`
         include_latest : bool
-          If False (default), n+1 lines are fetched, and the latest one
-          is discarded. This is intended to be used where the function
-          is called by a user command, which it should not return.
+            If False (default), n+1 lines are fetched, and the latest one
+            is discarded. This is intended to be used where the function
+            is called by a user command, which it should not return.
 
         Returns
         -------
@@ -373,16 +371,16 b' class HistoryAccessor(HistoryAccessorBase):'
         Parameters
         ----------
         pattern : str
-          The wildcarded pattern to match when searching
+            The wildcarded pattern to match when searching
         search_raw : bool
-          If True, search the raw input, otherwise, the parsed input
+            If True, search the raw input, otherwise, the parsed input
         raw, output : bool
-          See :meth:`get_range`
+            See :meth:`get_range`
         n : None or int
-          If an integer is given, it defines the limit of
-          returned entries.
+            If an integer is given, it defines the limit of
+            returned entries.
         unique : bool
-          When it is true, return only unique entries.
+            When it is true, return only unique entries.
 
         Returns
         -------
@@ -430,9 +428,9 b' class HistoryAccessor(HistoryAccessorBase):'
         Returns
         -------
         entries
-          An iterator over the desired lines. Each line is a 3-tuple, either
-          (session, line, input) if output is False, or
-          (session, line, (input, output)) if output is True.
+            An iterator over the desired lines. Each line is a 3-tuple, either
+            (session, line, input) if output is False, or
+            (session, line, (input, output)) if output is True.
         """
         if stop:
             lineclause = "line >= ? AND line < ?"
@@ -451,13 +449,13 b' class HistoryAccessor(HistoryAccessorBase):'
         Parameters
         ----------
         rangestr : str
-          A string specifying ranges, e.g. "5 ~2/1-4". If empty string is used,
-          this will return everything from current session's history.
+            A string specifying ranges, e.g. "5 ~2/1-4". If empty string is used,
+            this will return everything from current session's history.
 
-          See the documentation of :func:`%history` for the full details.
+            See the documentation of :func:`%history` for the full details.
 
         raw, output : bool
-          As :meth:`get_range`
+            As :meth:`get_range`
 
         Returns
         -------
@@ -605,24 +603,22 b' class HistoryManager(HistoryAccessor):'
 
         Parameters
         ----------
-
         session : int
             Session number to retrieve. The current session is 0, and negative
             numbers count back from current session, so -1 is the previous session.
 
         Returns
         -------
-
         session_id : int
-           Session ID number
+            Session ID number
         start : datetime
-           Timestamp for the start of the session.
+            Timestamp for the start of the session.
         end : datetime
-           Timestamp for the end of the session, or None if IPython crashed.
+            Timestamp for the end of the session, or None if IPython crashed.
         num_cmds : int
-           Number of commands run, or None if IPython crashed.
+            Number of commands run, or None if IPython crashed.
         remark : unicode
-           A manually set description.
+            A manually set description.
         """
         if session <= 0:
             session += self.session_number
@@ -673,9 +669,9 b' class HistoryManager(HistoryAccessor):'
         Returns
         -------
         entries
-          An iterator over the desired lines. Each line is a 3-tuple, either
-          (session, line, input) if output is False, or
-          (session, line, (input, output)) if output is True.
+            An iterator over the desired lines. Each line is a 3-tuple, either
+            (session, line, input) if output is False, or
+            (session, line, (input, output)) if output is True.
         """
         if session <= 0:
             session += self.session_number
@@ -694,14 +690,12 b' class HistoryManager(HistoryAccessor):'
         Parameters
         ----------
         line_num : int
-          The prompt number of this input.
-
+            The prompt number of this input.
         source : str
-          Python input.
-
+            Python input.
         source_raw : str, optional
-          If given, this is the raw input without any IPython transformations
-          applied to it.  If not given, ``source`` is used.
+            If given, this is the raw input without any IPython transformations
+            applied to it.  If not given, ``source`` is used.
         """
         if source_raw is None:
             source_raw = source
@@ -745,7 +739,7 b' class HistoryManager(HistoryAccessor):'
         Parameters
         ----------
         line_num : int
-          The line number from which to save outputs
+            The line number from which to save outputs
         """
         if (not self.db_log_output) or (line_num not in self.output_hist_reprs):
             return

IPython/core/inputsplitter.py

@@ -210,7 +210,7 b' def last_blank(src):'
     Parameters
     ----------
     src : string
-      A single or multiline string.
+        A single or multiline string.
     """
     if not src: return False
     ll  = src.splitlines()[-1]
@@ -228,7 +228,7 b' def last_two_blanks(src):'
     Parameters
     ----------
     src : string
-      A single or multiline string.
+        A single or multiline string.
     """
     if not src: return False
     # The logic here is tricky: I couldn't get a regexp to work and pass all
@@ -251,7 +251,7 b' def remove_comments(src):'
     Parameters
     ----------
     src : string
-      A single or multiline input string.
+        A single or multiline input string.
 
     Returns
     -------
@@ -351,22 +351,22 b' class InputSplitter(object):'
 
     def check_complete(self, source):
         """Return whether a block of code is ready to execute, or should be continued
-        
+
         This is a non-stateful API, and will reset the state of this InputSplitter.
-        
+
         Parameters
         ----------
         source : string
-          Python input code, which can be multiline.
-        
+            Python input code, which can be multiline.
+
         Returns
         -------
         status : str
-          One of 'complete', 'incomplete', or 'invalid' if source is not a
-          prefix of valid code.
+            One of 'complete', 'incomplete', or 'invalid' if source is not a
+            prefix of valid code.
         indent_spaces : int or None
-          The number of spaces by which to indent the next line of code. If
-          status is not 'incomplete', this is None.
+            The number of spaces by which to indent the next line of code. If
+            status is not 'incomplete', this is None.
         """
         self.reset()
         try:
@@ -397,15 +397,15 b' class InputSplitter(object):'
         Parameters
         ----------
         lines : string
-          One or more lines of Python input.
+            One or more lines of Python input.
 
         Returns
         -------
         is_complete : boolean
-          True if the current input source (the result of the current input
-          plus prior inputs) forms a complete Python execution block.  Note that
-          this value is also stored as a private attribute (``_is_complete``), so it
-          can be queried at any time.
+            True if the current input source (the result of the current input
+            plus prior inputs) forms a complete Python execution block.  Note that
+            this value is also stored as a private attribute (``_is_complete``), so it
+            can be queried at any time.
         """
         assert isinstance(lines, str)
         self._store(lines)
@@ -448,7 +448,7 b' class InputSplitter(object):'
         guess whether a block is complete or not based solely on prior and
         current input lines.  The InputSplitter considers it has a complete
         interactive block and will not accept more input when either:
-        
+
         * A SyntaxError is raised
 
         * The code is complete and consists of a single line or a single
@@ -618,9 +618,9 b' class IPythonInputSplitter(InputSplitter):'
     def flush_transformers(self):
         def _flush(transform, outs):
             """yield transformed lines
-            
+
             always strings, never None
-            
+
             transform: the current transform
             outs: an iterable of previously transformed inputs.
                  Each may be multiline, which will be passed
@@ -690,15 +690,15 b' class IPythonInputSplitter(InputSplitter):'
         Parameters
         ----------
         lines : string
-          One or more lines of Python input.
+            One or more lines of Python input.
 
         Returns
         -------
         is_complete : boolean
-          True if the current input source (the result of the current input
-          plus prior inputs) forms a complete Python execution block.  Note that
-          this value is also stored as a private attribute (_is_complete), so it
-          can be queried at any time.
+            True if the current input source (the result of the current input
+            plus prior inputs) forms a complete Python execution block.  Note that
+            this value is also stored as a private attribute (_is_complete), so it
+            can be queried at any time.
         """
         assert isinstance(lines, str)
         # We must ensure all input is pure unicode
@@ -728,10 +728,10 b' class IPythonInputSplitter(InputSplitter):'
 
     def _transform_line(self, line):
         """Push a line of input code through the various transformers.
-        
+
         Returns any output from the transformers, or None if a transformer
         is accumulating lines.
-        
+
         Sets self.transformer_accumulating as a side effect.
         """
         def _accumulating(dbg):

IPython/core/inputtransformer.py

@@ -46,7 +46,7 b' class InputTransformer(metaclass=abc.ABCMeta):'
     def push(self, line):
         """Send a line of input to the transformer, returning the transformed
         input or None if the transformer is waiting for more input.
-        
+
         Must be overridden by subclasses.
 
         Implementations may raise ``SyntaxError`` if the input is invalid. No
@@ -58,7 +58,7 b' class InputTransformer(metaclass=abc.ABCMeta):'
     def reset(self):
         """Return, transformed any lines that the transformer has accumulated,
         and reset its internal state.
-        
+
         Must be overridden by subclasses.
         """
         pass
@@ -312,7 +312,7 b' def has_comment(src):'
     Parameters
     ----------
     src : string
-      A single line input string.
+        A single line input string.
 
     Returns
     -------
@@ -324,11 +324,11 b' def has_comment(src):'
 def ends_in_comment_or_string(src):
     """Indicates whether or not an input line ends in a comment or within
     a multiline string.
-    
+
     Parameters
     ----------
     src : string
-      A single line input string.
+        A single line input string.
 
     Returns
     -------
@@ -358,7 +358,7 b' def help_end(line):'
 @CoroutineInputTransformer.wrap
 def cellmagic(end_on_blank_line=False):
     """Captures & transforms cell magics.
-    
+
     After a cell magic is started, this stores up any lines it gets until it is
     reset (sent None).
     """
@@ -397,7 +397,7 b' def cellmagic(end_on_blank_line=False):'
 
 def _strip_prompts(prompt_re, initial_re=None, turnoff_re=None):
     """Remove matching input prompts from a block of input.
-    
+
     Parameters
     ----------
     prompt_re : regular expression
@@ -407,7 +407,6 b' def _strip_prompts(prompt_re, initial_re=None, turnoff_re=None):'
         If no initial expression is given, prompt_re will be used everywhere.
         Used mainly for plain Python prompts, where the continuation prompt
         ``...`` is a valid Python expression in Python 3, so shouldn't be stripped.
-    
     If initial_re and prompt_re differ,
     only initial_re will be tested against the first line.
     If any prompt is found on the first two lines,
@@ -475,7 +474,7 b' def ipy_prompt():'
 @CoroutineInputTransformer.wrap
 def leading_indent():
     """Remove leading indentation.
-    
+
     If the first line starts with a spaces or tabs, the same whitespace will be
     removed from each following line until it is reset.
     """

IPython/core/inputtransformer2.py

@@ -640,17 +640,17 b' class TransformerManager:'
 
         Parameters
         ----------
-        source : string
-          Python input code, which can be multiline.
+        cell : string
+            Python input code, which can be multiline.
 
         Returns
         -------
         status : str
-          One of 'complete', 'incomplete', or 'invalid' if source is not a
-          prefix of valid code.
+            One of 'complete', 'incomplete', or 'invalid' if source is not a
+            prefix of valid code.
         indent_spaces : int or None
-          The number of spaces by which to indent the next line of code. If
-          status is not 'incomplete', this is None.
+            The number of spaces by which to indent the next line of code. If
+            status is not 'incomplete', this is None.
         """
         # Remember if the lines ends in a new line.
         ends_with_newline = False

IPython/core/interactiveshell.py

@@ -1730,7 +1730,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-
         exc_tuple : tuple of exception classes
             A *tuple* of exception classes, for which to call the defined
             handler.  It is very important that you use a tuple, and NOT A
@@ -1760,7 +1759,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Notes
         -----
-
         WARNING: by putting in your own exception handler into IPython's main
         execution loop, you run a very good chance of nasty crashes.  This
         facility should only be used if you really know what you are doing.
@@ -1975,7 +1973,7 b' class InteractiveShell(SingletonConfigurable):'
 
         If the syntax error occurred when running a compiled code (i.e. running_compile_code=True),
         longer stack trace will be displayed.
-         """
+        """
         etype, value, last_traceback = self._get_exc_info()
 
         if filename and issubclass(etype, SyntaxError):
@@ -2056,26 +2054,21 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-
-           text : string
-             A string of text to be completed on.  It can be given as empty and
-             instead a line/position pair are given.  In this case, the
-             completer itself will split the line like readline does.
-
-           line : string, optional
-             The complete line that text is part of.
-
-           cursor_pos : int, optional
-             The position of the cursor on the input line.
+        text : string
+            A string of text to be completed on.  It can be given as empty and
+            instead a line/position pair are given.  In this case, the
+            completer itself will split the line like readline does.
+        line : string, optional
+            The complete line that text is part of.
+        cursor_pos : int, optional
+            The position of the cursor on the input line.
 
         Returns
         -------
         text : string
-          The actual text that was completed.
-
+            The actual text that was completed.
         matches : list
-          A sorted list with all possible completions.
-
+            A sorted list with all possible completions.
 
         Notes
         -----
@@ -2089,7 +2082,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Examples
         --------
-
         In [1]: x = 'hello'
 
         In [2]: _ip.complete('x.l')
@@ -2343,9 +2335,9 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         cmd : str
-          Command to execute (can not end in '&', as background processes are
-          not supported.  Should not be a command that expects input
-          other than simple text.
+            Command to execute (can not end in '&', as background processes are
+            not supported.  Should not be a command that expects input
+            other than simple text.
         """
         if cmd.rstrip().endswith('&'):
             # this is *far* from a rigorous test
@@ -2367,7 +2359,7 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         cmd : str
-          Command to execute.
+            Command to execute.
         """
         cmd = self.var_expand(cmd, depth=1)
         # warn if there is an IPython magic alternative.
@@ -2435,18 +2427,18 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         cmd : str
-          Command to execute (can not end in '&', as background processes are
-          not supported.
+            Command to execute (can not end in '&', as background processes are
+            not supported.
         split : bool, optional
-          If True, split the output into an IPython SList.  Otherwise, an
-          IPython LSString is returned.  These are objects similar to normal
-          lists and strings, with a few convenience attributes for easier
-          manipulation of line-based output.  You can use '?' on them for
-          details.
+            If True, split the output into an IPython SList.  Otherwise, an
+            IPython LSString is returned.  These are objects similar to normal
+            lists and strings, with a few convenience attributes for easier
+            manipulation of line-based output.  You can use '?' on them for
+            details.
         depth : int, optional
-          How many frames above the caller are the local variables which should
-          be expanded in the command string? The default (0) assumes that the
-          expansion variables are in the stack frame calling this function.
+            How many frames above the caller are the local variables which should
+            be expanded in the command string? The default (0) assumes that the
+            expansion variables are in the stack frame calling this function.
         """
         if cmd.rstrip().endswith('&'):
             # this is *far* from a rigorous test
@@ -2557,9 +2549,9 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         expressions : dict
-          A dict with string keys and string values.  The expression values
-          should be valid Python expressions, each of which will be evaluated
-          in the user namespace.
+            A dict with string keys and string values.  The expression values
+            should be valid Python expressions, each of which will be evaluated
+            in the user namespace.
 
         Returns
         -------
@@ -2606,7 +2598,7 b' class InteractiveShell(SingletonConfigurable):'
         ----------
         fname : string
             The name of the file to be executed.
-        where : tuple
+        *where : tuple
             One or two namespaces, passed to execfile() as (globals,locals).
             If only one is given, it is passed as both.
         exit_ignore : bool (False)
@@ -2755,19 +2747,19 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         raw_cell : str
-          The code (including IPython code such as %magic functions) to run.
+            The code (including IPython code such as %magic functions) to run.
         store_history : bool
-          If True, the raw and translated cell will be stored in IPython's
-          history. For user code calling back into IPython's machinery, this
-          should be set to False.
+            If True, the raw and translated cell will be stored in IPython's
+            history. For user code calling back into IPython's machinery, this
+            should be set to False.
         silent : bool
-          If True, avoid side-effects, such as implicit displayhooks and
-          and logging.  silent=True forces store_history=False.
+            If True, avoid side-effects, such as implicit displayhooks and
+            and logging.  silent=True forces store_history=False.
         shell_futures : bool
-          If True, the code will share future statements with the interactive
-          shell. It will both be affected by previous __future__ imports, and
-          any __future__ imports in the code will affect the shell. If False,
-          __future__ imports are not shared in either direction.
+            If True, the code will share future statements with the interactive
+            shell. It will both be affected by previous __future__ imports, and
+            any __future__ imports in the code will affect the shell. If False,
+            __future__ imports are not shared in either direction.
 
         Returns
         -------
@@ -2836,14 +2828,13 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-        raw_cell: str
+        raw_cell : str
             The code to be executed
 
         Returns
         -------
         result: bool
             Whether the code needs to be run with a coroutine runner or not
-
         .. versionadded:: 7.0
         """
         if not self.autoawait:
@@ -3075,8 +3066,8 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         node : ast.Node
-          The root node to be transformed. Typically called with the ast.Module
-          produced by parsing user input.
+            The root node to be transformed. Typically called with the ast.Module
+            produced by parsing user input.
 
         Returns
         -------
@@ -3290,17 +3281,17 b' class InteractiveShell(SingletonConfigurable):'
 
         Parameters
         ----------
-        source : string
-          Python input code, which can be multiline.
+        code : string
+            Python input code, which can be multiline.
 
         Returns
         -------
         status : str
-          One of 'complete', 'incomplete', or 'invalid' if source is not a
-          prefix of valid code.
+            One of 'complete', 'incomplete', or 'invalid' if source is not a
+            prefix of valid code.
         indent : str
-          When status is 'incomplete', this is some whitespace to insert on
-          the next line of the prompt.
+            When status is 'incomplete', this is some whitespace to insert on
+            the next line of the prompt.
         """
         status, nspaces = self.input_transformer_manager.check_complete(code)
         return status, ' ' * (nspaces or 0)
@@ -3327,13 +3318,13 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         gui : optional, string
-          If given, dictates the choice of matplotlib GUI backend to use
-          (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
-          'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
-          matplotlib (as dictated by the matplotlib build-time options plus the
-          user's matplotlibrc configuration file).  Note that not all backends
-          make sense in all contexts, for example a terminal ipython can't
-          display figures inline.
+            If given, dictates the choice of matplotlib GUI backend to use
+            (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
+            'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
+            matplotlib (as dictated by the matplotlib build-time options plus the
+            user's matplotlibrc configuration file).  Note that not all backends
+            make sense in all contexts, for example a terminal ipython can't
+            display figures inline.
         """
         from IPython.core import pylabtools as pt
         from matplotlib_inline.backend_inline import configure_inline_support
@@ -3373,18 +3364,18 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         gui : optional, string
-          If given, dictates the choice of matplotlib GUI backend to use
-          (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
-          'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
-          matplotlib (as dictated by the matplotlib build-time options plus the
-          user's matplotlibrc configuration file).  Note that not all backends
-          make sense in all contexts, for example a terminal ipython can't
-          display figures inline.
+            If given, dictates the choice of matplotlib GUI backend to use
+            (should be one of IPython's supported backends, 'qt', 'osx', 'tk',
+            'gtk', 'wx' or 'inline'), otherwise we use the default chosen by
+            matplotlib (as dictated by the matplotlib build-time options plus the
+            user's matplotlibrc configuration file).  Note that not all backends
+            make sense in all contexts, for example a terminal ipython can't
+            display figures inline.
         import_all : optional, bool, default: True
-          Whether to do `from numpy import *` and `from pylab import *`
-          in addition to module imports.
+            Whether to do `from numpy import *` and `from pylab import *`
+            in addition to module imports.
         welcome_message : deprecated
-          This argument is ignored, no welcome message will be displayed.
+            This argument is ignored, no welcome message will be displayed.
         """
         from IPython.core.pylabtools import import_pylab
 
@@ -3491,7 +3482,6 b' class InteractiveShell(SingletonConfigurable):'
 
         Notes
         -----
-
         Slices can be described with two notations:
 
         * ``N:M`` -> standard python form, means including items N...(M-1).
@@ -3517,26 +3507,25 b' class InteractiveShell(SingletonConfigurable):'
         Parameters
         ----------
         target : str
-          A string specifying code to retrieve. This will be tried respectively
-          as: ranges of input history (see %history for syntax), url,
-          corresponding .py file, filename, or an expression evaluating to a
-          string or Macro in the user namespace.
+            A string specifying code to retrieve. This will be tried respectively
+            as: ranges of input history (see %history for syntax), url,
+            corresponding .py file, filename, or an expression evaluating to a
+            string or Macro in the user namespace.
 
-          If empty string is given, returns complete history of current
-          session, without the last line.
+            If empty string is given, returns complete history of current
+            session, without the last line.
 
         raw : bool
-          If true (default), retrieve raw history. Has no effect on the other
-          retrieval mechanisms.
+            If true (default), retrieve raw history. Has no effect on the other
+            retrieval mechanisms.
 
         py_only : bool (default False)
-          Only try to fetch python code, do not try alternative methods to decode file
-          if unicode fails.
+            Only try to fetch python code, do not try alternative methods to decode file
+            if unicode fails.
 
         Returns
         -------
         A string of code.
-
         ValueError is raised if nothing is found, and TypeError if it evaluates
         to an object of another type. In each case, .args[0] is a printable
         message.

IPython/core/magic.py

@@ -114,16 +114,13 b' def record_magic(dct, magic_kind, magic_name, func):'
     Parameters
     ----------
     dct : dict
-      A dictionary with 'line' and 'cell' subdicts.
-
+        A dictionary with 'line' and 'cell' subdicts.
     magic_kind : str
-      Kind of magic to be stored.
-
+        Kind of magic to be stored.
     magic_name : str
-      Key to store the magic as.
-
+        Key to store the magic as.
     func : function
-      Callable object to store.
+        Callable object to store.
     """
     if magic_kind == 'line_cell':
         dct['line'][magic_name] = dct['cell'][magic_name] = func
@@ -372,7 +369,7 b' class MagicsManager(Configurable):'
     def register(self, *magic_objects):
         """Register one or more instances of Magics.
 
-        Take one or more classes or instances of classes that subclass the main 
+        Take one or more classes or instances of classes that subclass the main
         `core.Magic` class, and register them with IPython to use the magic
         functions they provide.  The registration process will then ensure that
         any methods that have decorated to provide line and/or cell magics will
@@ -387,7 +384,7 b' class MagicsManager(Configurable):'
 
         Parameters
         ----------
-        magic_objects : one or more classes or instances
+        *magic_objects : one or more classes or instances
         """
         # Start by validating them to ensure they have all had their magic
         # methods registered at the instance level
@@ -410,7 +407,7 b' class MagicsManager(Configurable):'
 
         This will create an IPython magic (line, cell or both) from a
         standalone function.  The functions should have the following
-        signatures: 
+        signatures:
 
         * For line magics: `def f(line)`
         * For cell magics: `def f(line, cell)`
@@ -422,14 +419,12 b' class MagicsManager(Configurable):'
         Parameters
         ----------
         func : callable
-          Function to be registered as a magic.
-
+            Function to be registered as a magic.
         magic_kind : str
-          Kind of magic, one of 'line', 'cell' or 'line_cell'
-
+            Kind of magic, one of 'line', 'cell' or 'line_cell'
         magic_name : optional str
-          If given, the name the magic will have in the IPython namespace.  By
-          default, the name of the function itself is used.
+            If given, the name the magic will have in the IPython namespace.  By
+            default, the name of the function itself is used.
         """
 
         # Create the new method in the user_magics and register it in the
@@ -450,13 +445,11 b' class MagicsManager(Configurable):'
         Parameters
         ----------
         alias_name : str
-          The name of the magic to be registered.
-
+            The name of the magic to be registered.
         magic_name : str
-          The name of an existing magic.
-
+            The name of an existing magic.
         magic_kind : str
-          Kind of magic, one of 'line' or 'cell'
+            Kind of magic, one of 'line' or 'cell'
         """
 
         # `validate_type` is too permissive, as it allows 'line_cell'
@@ -580,25 +573,20 b' class Magics(Configurable):'
 
         Parameters
         ----------
-
         arg_str : str
-          The arguments to parse.
-
+            The arguments to parse.
         opt_str : str
-          The options specification.
-
+            The options specification.
         mode : str, default 'string'
-          If given as 'list', the argument string is returned as a list (split
-          on whitespace) instead of a string.
-
+            If given as 'list', the argument string is returned as a list (split
+            on whitespace) instead of a string.
         list_all : bool, default False
-          Put all option values in lists. Normally only options
-          appearing more than once are put in a list.
-
+            Put all option values in lists. Normally only options
+            appearing more than once are put in a list.
         posix : bool, default True
-          Whether to split the input line in POSIX mode or not, as per the
-          conventions outlined in the :mod:`shlex` module from the standard
-          library.
+            Whether to split the input line in POSIX mode or not, as per the
+            conventions outlined in the :mod:`shlex` module from the standard
+            library.
         """
 
         # inject default options at the beginning of the input line

IPython/core/magics/basic.py

@@ -46,7 +46,7 b' class MagicsDisplay(object):'
     
     def _jsonable(self):
         """turn magics dict into jsonable dict of the same structure
-        
+
         replaces object instances with their class names as strings
         """
         magic_dict = {}
@@ -124,7 +124,7 b' class BasicMagics(Magics):'
 
           In [6]: %whereami
           Out[6]: u'/home/testuser'
-          
+
           In [7]: %alias_magic h history "-p -l 30" --line
           Created `%h` as an alias for `%history -l 30`.
         """
@@ -368,7 +368,7 b' Currently the magic system has the following functions:""",'
 
         If called without arguments, acts as a toggle.
 
-        When in verbose mode the value --show (and --hide) 
+        When in verbose mode the value --show (and --hide)
         will respectively show (or hide) frames with ``__tracebackhide__ =
         True`` value set.
         """
@@ -618,12 +618,11 b' class AsyncMagics(BasicMagics):'
 
         If the passed parameter does not match any of the above and is a python
         identifier, get said object from user namespace and set it as the
-        runner, and activate autoawait. 
+        runner, and activate autoawait.
 
         If the object is a fully qualified object name, attempt to import it and
         set it as the runner, and activate autoawait.
-        
-        
+
         The exact behavior of autoawait is experimental and subject to change
         across version of IPython and Python.
         """

IPython/core/magics/execution.py

@@ -1067,7 +1067,6 b' class ExecutionMagics(Magics):'
 
           In [6]: %timeit -n1 time.sleep(2)
 
-
         The times reported by %timeit will be slightly higher than those
         reported by the timeit.py script when variables are accessed. This is
         due to the fact that %timeit executes the statement in the namespace
@@ -1201,7 +1200,7 b' class ExecutionMagics(Magics):'
         The CPU and wall clock times are printed, and the value of the
         expression (if any) is returned.  Note that under Win32, system time
         is always reported as 0, since it can not be measured.
-        
+
         This function can be used both as a line and cell magic:
 
         - In line mode you can time a single-line statement (though multiple
@@ -1238,7 +1237,6 b' class ExecutionMagics(Magics):'
           CPU times: user 0.00 s, sys: 0.00 s, total: 0.00 s
           Wall time: 0.00
 
-
         .. note::
             The time needed by Python to compile the given expression will be
             reported if it is more than 0.1s.

IPython/core/magics/extension.py

@@ -41,7 +41,7 b' class ExtensionMagics(Magics):'
     @line_magic
     def unload_ext(self, module_str):
         """Unload an IPython extension by its module name.
-        
+
         Not all extensions can be unloaded, only those which define an
         ``unload_ipython_extension`` function.
         """

IPython/core/magics/history.py

@@ -105,7 +105,7 b' class HistoryMagics(Magics):'
 
         By default, all input history from the current session is displayed.
         Ranges of history can be indicated using the syntax:
-        
+
         ``4``
             Line 4, current session
         ``4-6``
@@ -117,7 +117,7 b' class HistoryMagics(Magics):'
         ``~8/1-~6/5``
             From the first line of 8 sessions ago, to the fifth line of 6
             sessions ago.
-        
+
         Multiple ranges can be entered, separated by spaces
 
         The same syntax is used by %macro, %save, %edit, %rerun

IPython/core/magics/namespace.py

@@ -173,7 +173,7 b' class NamespaceMagics(Magics):'
           'builtin', 'user', 'user_global','internal', 'alias', where
           'builtin' and 'user' are the search defaults.  Note that you should
           not use quotes when specifying namespaces.
-          
+
           -l: List all available object types for object matching. This function
           can be used without arguments.
 
@@ -203,9 +203,9 b' class NamespaceMagics(Magics):'
         Show objects beginning with a single _::
 
           %psearch -a _*         list objects beginning with a single underscore
-          
+
         List available objects::
-        
+
           %psearch -l            list all available object types
         """
         # default namespaces to be searched
@@ -252,7 +252,6 b' class NamespaceMagics(Magics):'
 
         Examples
         --------
-
         Define two variables and list them with who_ls::
 
           In [1]: alpha = 123
@@ -367,7 +366,6 b' class NamespaceMagics(Magics):'
 
         Examples
         --------
-
         Define two variables and list them with whos::
 
           In [1]: alpha = 123
@@ -484,23 +482,21 b' class NamespaceMagics(Magics):'
 
         Parameters
         ----------
-        -f : force reset without asking for confirmation.
-
-        -s : 'Soft' reset: Only clears your namespace, leaving history intact.
+        -f
+           force reset without asking for confirmation.
+        -s
+           'Soft' reset: Only clears your namespace, leaving history intact.
             References to objects may be kept. By default (without this option),
             we do a 'hard' reset, giving you a new session and removing all
             references to objects from the current session.
-
-        --aggressive: Try to aggressively remove modules from sys.modules ; this
+        --aggressive
+            Try to aggressively remove modules from sys.modules ; this
             may allow you to reimport Python modules that have been updated and
             pick up changes, but can have unattended consequences.
 
         in : reset input history
-
         out : reset output history
-
         dhist : reset directory history
-
         array : reset only variables that are NumPy arrays
 
         See Also
@@ -624,7 +620,6 b' class NamespaceMagics(Magics):'
 
         Examples
         --------
-
         We first fully reset the namespace so your output looks identical to
         this example for pedagogical reasons; in practice you do not need a
         full reset::

IPython/core/magics/osm.py

@@ -65,7 +65,7 b' class OSMagics(Magics):'
 
     def _isexec_POSIX(self, file):
         """
-            Test for executable on a POSIX system
+        Test for executable on a POSIX system
         """
         if os.access(file.path, os.X_OK):
             # will fail on maxOS if access is not X_OK
@@ -76,13 +76,13 b' class OSMagics(Magics):'
     
     def _isexec_WIN(self, file):
         """
-            Test for executable file on non POSIX system
+        Test for executable file on non POSIX system
         """
         return file.is_file() and self.execre.match(file.name) is not None
 
     def isexec(self, file):
         """
-            Test for executable file on non POSIX system
+        Test for executable file on non POSIX system
         """
         if self.is_posix:
             return self._isexec_POSIX(file)
@@ -316,7 +316,6 b' class OSMagics(Magics):'
             ``cd <bookmark_name>`` is enough if there is no directory
             ``<bookmark_name>``, but a bookmark with the name exists.
 
-
         Options:
 
         -q               Be quiet. Do not print the working directory after the
@@ -329,7 +328,6 b' class OSMagics(Magics):'
            where ``!command`` runs is immediately discarded after executing
            'command'.
 
-
         Examples
         --------
         ::
@@ -834,7 +832,7 b' class OSMagics(Magics):'
     @cell_magic
     def writefile(self, line, cell):
         """Write the contents of the cell to a file.
-        
+
         The file will be overwritten unless the -a (--append) flag is specified.
         """
         args = magic_arguments.parse_argstring(self.writefile, line)

IPython/core/magics/script.py

@@ -202,16 +202,16 b' class ScriptMagics(Magics):'
     @dec_safe_watcher
     def shebang(self, line, cell):
         """Run a cell via a shell command
-        
+
         The `%%script` line is like the #! line of script,
         specifying a program (bash, perl, ruby, etc.) with which to run.
-        
+
         The rest of the cell is run by that program.
-        
+
         Examples
         --------
         ::
-        
+
             In [1]: %%script bash
                ...: for i in 1 2 3; do
                ...:   echo $i

IPython/core/oinspect.py

@@ -302,7 +302,7 b' def find_file(obj) -> str:'
     Returns
     -------
     fname : str
-      The absolute path to the file where the object was defined.
+        The absolute path to the file where the object was defined.
     """
     obj = _get_wrapped(obj)
 
@@ -337,7 +337,7 b' def find_source_lines(obj):'
     Returns
     -------
     lineno : int
-      The line number where the object definition starts.
+        The line number where the object definition starts.
     """
     obj = _get_wrapped(obj)
 
@@ -428,7 +428,6 b' class Inspector(Colorable):'
 
         Examples
         --------
-
         In [1]: class NoInit:
            ...:     pass
 
@@ -575,18 +574,17 b' class Inspector(Colorable):'
         """Retrieve an info dict and format it.
 
         Parameters
-        ==========
-
-        obj: any
+        ----------
+        obj : any
             Object to inspect and return info from
         oname: str (default: ''):
             Name of the variable pointing to `obj`.
-        formatter: callable
+        formatter : callable
         info:
             already computed information
-        detail_level: integer
+        detail_level : integer
             Granularity of detail level, if set to 1, give more information.
-        omit_sections: container[str]
+        omit_sections : container[str]
             Titles or keys to omit from output (can be set, tuple, etc., anything supporting `in`)
         """
 
@@ -716,21 +714,19 b' class Inspector(Colorable):'
         """Compute a dict with detailed information about an object.
 
         Parameters
-        ==========
-
-        obj: any
+        ----------
+        obj : any
             An object to find information about
-        oname: str (default: ''):
+        oname : str (default: '')
             Name of the variable pointing to `obj`.
-        info: (default: None)
+        info : (default: None)
             A struct (dict like with attr access) with some information fields
             which may have been precomputed already.
-        detail_level: int (default:0)
+        detail_level : int (default:0)
             If set to 1, more information is given.
 
         Returns
-        =======
-
+        -------
         An object info dict with known fields from `info_fields`. Keys are
         strings, values are string or None.
         """
@@ -962,7 +958,7 b' class Inspector(Colorable):'
 
           - show_all(False): show all names, including those starting with
             underscores.
-            
+
           - list_types(False): list all available object types for object matching.
         """
         #print 'ps pattern:<%r>' % pattern # dbg

IPython/core/page.py

@@ -46,7 +46,7 b' def display_page(strng, start=0, screen_lines=25):'
 
 def as_hook(page_func):
     """Wrap a pager func to strip the `self` arg
-    
+
     so it can be called as a hook.
     """
     return lambda self, *args, **kwargs: page_func(*args, **kwargs)
@@ -127,7 +127,7 b' def _detect_screen_size(screen_lines_def):'
 
 def pager_page(strng, start=0, screen_lines=0, pager_cmd=None):
     """Display a string, piping through a pager after a certain length.
-    
+
     strng can be a mime-bundle dict, supplying multiple representations,
     keyed by mime-type.
 
@@ -238,10 +238,10 b' def pager_page(strng, start=0, screen_lines=0, pager_cmd=None):'
 
 def page(data, start=0, screen_lines=0, pager_cmd=None):
     """Display content in a pager, piping through a pager after a certain length.
-    
+
     data can be a mime-bundle dict, supplying multiple representations,
     keyed by mime-type, or text.
-    
+
     Pager is dispatched via the `show_in_pager` IPython hook.
     If no hook is registered, `pager_page` will be used.
     """

IPython/core/payloadpage.py

@@ -17,10 +17,9 b' def page(strng, start=0, screen_lines=0, pager_cmd=None):'
     Parameters
     ----------
     strng : str or mime-dict
-      Text to page, or a mime-type keyed dict of already formatted data.
-
+        Text to page, or a mime-type keyed dict of already formatted data.
     start : int
-      Starting line at which to place the display.
+        Starting line at which to place the display.
     """
 
     # Some routines may auto-compute start offsets incorrectly and pass a
@@ -42,7 +41,7 b' def page(strng, start=0, screen_lines=0, pager_cmd=None):'
 
 def install_payload_page():
     """DEPRECATED, use show_in_pager hook
-    
+
     Install this version of page as IPython.core.page.page.
     """
     warnings.warn("""install_payload_page is deprecated.

IPython/core/pylabtools.py

@@ -185,8 +185,8 b' def mpl_runner(safe_execfile):'
     Parameters
     ----------
     safe_execfile : function
-      This must be a function with the same interface as the
-      :meth:`safe_execfile` method of IPython.
+        This must be a function with the same interface as the
+        :meth:`safe_execfile` method of IPython.
 
     Returns
     -------
@@ -241,7 +241,7 b' def select_figure_formats(shell, formats, **kwargs):'
     """Select figure formats for the inline backend.
 
     Parameters
-    ==========
+    ----------
     shell : InteractiveShell
         The main IPython instance.
     formats : str or set
@@ -408,7 +408,6 b' def configure_inline_support(shell, backend):'
     Parameters
     ----------
     shell : InteractiveShell instance
-
     backend : matplotlib backend
     """
     warnings.warn(

IPython/core/ultratb.py

@@ -556,7 +556,7 b' class ListTB(TBTools):'
         Parameters
         ----------
         etype : exception type
-        evalue : exception value
+        value : exception value
         """
         return ListTB.structured_traceback(self, etype, value)
 

IPython/external/qt_loaders.py

@@ -75,7 +75,7 b' sys.meta_path.insert(0, ID)'
 
 def commit_api(api):
     """Commit to a particular API, and trigger ImportErrors on subsequent
-       dangerous imports"""
+    dangerous imports"""
     modules = set(api_to_module.values())
 
     modules.remove(api_to_module[api])
@@ -115,15 +115,15 b' def loaded_api():'
 def has_binding(api):
     """Safely check for PyQt4/5, PySide or PySide2, without importing submodules
 
-        Parameters
-        ----------
-        api : str [ 'pyqtv1' | 'pyqt' | 'pyqt5' | 'pyside' | 'pyside2' | 'pyqtdefault']
-             Which module to check for
+    Parameters
+    ----------
+    api : str [ 'pyqtv1' | 'pyqt' | 'pyqt5' | 'pyside' | 'pyside2' | 'pyqtdefault']
+        Which module to check for
 
-        Returns
-        -------
-        True if the relevant module appears to be importable
-     """
+    Returns
+    -------
+    True if the relevant module appears to be importable
+    """
     module_name = api_to_module[api]
     from importlib.util import find_spec
 
@@ -193,9 +193,8 b' def import_pyqt4(version=2):'
     Parameters
     ----------
     version : 1, 2, or None
-      Which QString/QVariant API to use. Set to None to use the system
-      default
-
+        Which QString/QVariant API to use. Set to None to use the system
+        default
     ImportErrors raised within this function are non-recoverable
     """
     # The new-style string API (version=2) automatically
@@ -319,13 +318,12 b' def load_qt(api_options):'
 
     Parameters
     ----------
-    api_options: List of strings
+    api_options : List of strings
         The order of APIs to try. Valid items are 'pyside', 'pyside2',
         'pyqt', 'pyqt5', 'pyqtv1' and 'pyqtdefault'
 
     Returns
     -------
-
     A tuple of QtCore, QtGui, QtSvg, QT_API
     The first three are the Qt modules. The last is the
     string indicating which module was loaded.

IPython/lib/backgroundjobs.py

@@ -116,7 +116,7 b' class BackgroundJobManager(object):'
         The given expression is passed to eval(), along with the optional
         global/local dicts provided.  If no dicts are given, they are
         extracted automatically from the caller's frame.
-        
+
         A Python statement is NOT a valid eval() expression.  Basically, you
         can only use as an eval() argument something which can go on the right
         of an '=' sign and be assigned to a variable.

IPython/lib/demo.py

@@ -239,7 +239,7 b' class Demo(object):'
             terminal16m
 
           - style('default'): a string of pygments style name to be used.
-          """
+        """
         if hasattr(src, "read"):
              # It seems to be a file or a file-like object
             self.fname = "from a file-like object"

IPython/lib/display.py

@@ -517,20 +517,20 b' class FileLinks(FileLink):'
                                fp_cleaner=None):
         """ generate built-in formatter function
 
-           this is used to define both the notebook and terminal built-in
-            formatters as they only differ by some wrapper text for each entry
-
-           dirname_output_format: string to use for formatting directory
-            names, dirname will be substituted for a single "%s" which
-            must appear in this string
-           fname_output_format: string to use for formatting file names,
-            if a single "%s" appears in the string, fname will be substituted
-            if two "%s" appear in the string, the path to fname will be
-             substituted for the first and fname will be substituted for the
-             second
-           fp_format: string to use for formatting filepaths, must contain
-            exactly two "%s" and the dirname will be substituted for the first
-            and fname will be substituted for the second
+        this is used to define both the notebook and terminal built-in
+         formatters as they only differ by some wrapper text for each entry
+
+        dirname_output_format: string to use for formatting directory
+         names, dirname will be substituted for a single "%s" which
+         must appear in this string
+        fname_output_format: string to use for formatting file names,
+         if a single "%s" appears in the string, fname will be substituted
+         if two "%s" appear in the string, the path to fname will be
+          substituted for the first and fname will be substituted for the
+          second
+        fp_format: string to use for formatting filepaths, must contain
+         exactly two "%s" and the dirname will be substituted for the first
+         and fname will be substituted for the second
         """
         def f(dirname, fnames, included_suffixes=None):
             result = []

IPython/lib/latextools.py

@@ -77,7 +77,6 b" def latex_to_png(s, encode=False, backend=None, wrap=False, color='Black',"
         format, e.g. '#AA20FA'.
     scale : float
         Scale factor for the resulting PNG.
-
     None is returned when the backend cannot be used.
 
     """

IPython/terminal/embed.py

@@ -49,7 +49,6 b' class EmbeddedMagics(Magics):'
         you may then kill it and the program will then continue to run without
         the interactive shell interfering again.
 
-
         Kill Instance Option:
 
             If for some reasons you need to kill the location where the instance
@@ -266,25 +265,21 b' class InteractiveShellEmbed(TerminalInteractiveShell):'
 
         Parameters
         ----------
-
-
         local_ns, module
-          Working local namespace (a dict) and module (a module or similar
-          object). If given as None, they are automatically taken from the scope
-          where the shell was called, so that program variables become visible.
-
+            Working local namespace (a dict) and module (a module or similar
+            object). If given as None, they are automatically taken from the scope
+            where the shell was called, so that program variables become visible.
         stack_depth : int
-          How many levels in the stack to go to looking for namespaces (when
-          local_ns or module is None). This allows an intermediate caller to
-          make sure that this function gets the namespace from the intended
-          level in the stack. By default (0) it will get its locals and globals
-          from the immediate caller.
-
+            How many levels in the stack to go to looking for namespaces (when
+            local_ns or module is None). This allows an intermediate caller to
+            make sure that this function gets the namespace from the intended
+            level in the stack. By default (0) it will get its locals and globals
+            from the immediate caller.
         compile_flags
-          A bit field identifying the __future__ features
-          that are enabled, as passed to the builtin :func:`compile` function.
-          If given as None, they are automatically taken from the scope where
-          the shell was called.
+            A bit field identifying the __future__ features
+            that are enabled, as passed to the builtin :func:`compile` function.
+            If given as None, they are automatically taken from the scope where
+            the shell was called.
 
         """
         

IPython/terminal/magics.py

@@ -113,9 +113,9 b' class TerminalMagics(Magics):'
 
         Shell escapes are not supported (yet).
 
-        See also
+        See Also
         --------
-        paste: automatically pull code from clipboard.
+        paste : automatically pull code from clipboard.
 
         Examples
         --------
@@ -176,9 +176,9 b' class TerminalMagics(Magics):'
 
         IPython statements (magics, shell escapes) are not supported (yet).
 
-        See also
+        See Also
         --------
-        cpaste: manually paste code into terminal until you mark its end.
+        cpaste : manually paste code into terminal until you mark its end.
         """
         opts, name = self.parse_options(parameter_s, 'rq', mode='string')
         if 'r' in opts:

docs/source/whatsnew/development.rst

@@ -22,12 +22,24 b' Need to be updated:'
 
    pr/*
 
-IPython 8.0 is bringing a number of new features and improvements to both the
+IPython 8.0 is bringing a large number of new features and improvements to both the
 user of the terminal and of the kernel via Jupyter. The removal of compatibility
 with older version of Python is also the opportunity to do a couple of
 performance improvement in particular with respect to startup time.
 
-The main change in IPython 8.0 is the integration of the ``stack_data`` package;
+This release contains 250+ Pull requests, in addition to many of the features
+and backports that have made it to the 7.x branch.
+
+We removed almost all features, arguments, functions, and modules that were
+marked as deprecated between IPython 1.0 and 5.0 and before. As reminder 5.0 was
+released in 2016, and 1.0 in 2013. Last release of the 5 branch was 5.10.0, in
+may 2020. The few remaining deprecated features have better deprecation warnings
+or errors.
+
+There are many change in IPython 8.0 will will try to describe subsequently,
+
+
+The first on is the integration of the ``stack_data`` package;
 which provide smarter information in traceback; in particular it will highlight
 the AST node where an error occurs which can help to quickly narrow down errors.
 
@@ -50,13 +62,34 b' IPython 8.0 is capable of telling you, where the index error occurs::'
     return x[0][i][0]
                 ^
 
+
+Numfocus Small Developer Grant
+------------------------------
+
 To prepare for Python 3.10 we have also started working on removing reliance and
 any dependency that is not Python 3.10 compatible; that include migrating our
-test suite to Pytest, and starting to remove nose.
+test suite to pytest, and starting to remove nose. This also mean that the
+``iptest`` command is now gone, and all testing is via pytest.
+
+This was in bog part thanks the NumFOCUS Small Developer grant, we were able to
+allocate 4000 to hire `Nikita Kniazev @Kojoley <https://github.com/Kojoley>`__
+who did a fantastic job at updating our code base, migrating to pytest, pushing
+our coverage, and fixing a large number of bugs. I highly recommend contacting
+them if you need help with C++ and Python projects
 
-We are also removing support for Python 3.6 allowing internal code to use more
+You can find all relevant issues and PRs with the SDG 2021 tag:
+
+https://github.com/ipython/ipython/issues?q=label%3A%22Numfocus+SDG+2021%22+
+
+Removing support for Older Python
+---------------------------------
+
+
+We are also removing support for Python up to 3.7 allowing internal code to use more
 efficient ``pathlib``, and make better use of type annotations.
 
+IMAGE : Pathlib, pathlib everywhere.
+
 The completer has also seen significant updates and make use of newer Jedi API
 offering faster and more reliable tab completion.
 
@@ -168,7 +201,154 b' Try ``%autoreload 3`` in an IPython session after running ``%load_ext autoreload'
 For more information please see unit test -
     extensions/tests/test_autoreload.py : 'test_autoload_newly_added_objects'
 
-=======
+
+Miscelanious
+------------
+
+Minimum supported
+
+
+History Range Glob feature
+==========================
+
+Previously, when using ``%history``, users could specify either
+a range of sessions and lines, for example:
+
+.. code-block:: python
+
+   ~8/1-~6/5   # see history from the first line of 8 sessions ago,
+               # to the fifth line of 6 sessions ago.``
+
+Or users could specify a glob pattern:
+
+.. code-block:: python
+
+   -g <pattern>  # glob ALL history for the specified pattern.
+
+However users could *not* specify both.
+
+If a user *did* specify both a range and a glob pattern,
+then the glob pattern would be used (globbing *all* history) *and the range would be ignored*.
+
+---
+
+With this enhancement, if a user specifies both a range and a glob pattern, then the glob pattern will be applied to the specified range of history.
+
+Don't start a multi line cell with sunken parenthesis
+-----------------------------------------------------
+
+From now on IPython will not ask for the next line of input when given a single
+line with more closing than opening brackets. For example, this means that if
+you (mis)type ']]' instead of '[]', a ``SyntaxError`` will show up, instead of
+the ``...:`` prompt continuation.
+
+IPython shell for ipdb interact
+-------------------------------
+
+The ipdb ``interact`` starts an IPython shell instead of Python's built-in ``code.interact()``.
+
+Automatic Vi prompt stripping
+=============================
+
+When pasting code into IPython, it will strip the leading prompt characters if
+there are any. For example, you can paste the following code into the console -
+it will still work, even though each line is prefixed with prompts (`In`,
+`Out`)::
+
+    In [1]: 2 * 2 == 4
+    Out[1]: True
+
+    In [2]: print("This still works as pasted")
+
+
+Previously, this was not the case for the Vi-mode prompts::
+
+    In [1]: [ins] In [13]: 2 * 2 == 4
+       ...: Out[13]: True
+       ...:
+      File "<ipython-input-1-727bb88eaf33>", line 1
+        [ins] In [13]: 2 * 2 == 4
+              ^
+    SyntaxError: invalid syntax
+
+This is now fixed, and Vi prompt prefixes - ``[ins]`` and ``[nav]`` -  are
+skipped just as the normal ``In`` would be.
+
+IPython shell can be started in the Vi mode using ``ipython
+--TerminalInteractiveShell.editing_mode=vi``
+
+Empty History Ranges
+====================
+
+A number of magics that take history ranges can now be used with an empty
+range. These magics are:
+
+ * ``%save``
+ * ``%load``
+ * ``%pastebin``
+ * ``%pycat``
+
+Using them this way will make them take the history of the current session up
+to the point of the magic call (such that the magic itself will not be
+included).
+
+Therefore it is now possible to save the whole history to a file using simple
+``%save <filename>``, load and edit it using ``%load`` (makes for a nice usage
+when followed with :kbd:`F2`), send it to dpaste.org using ``%pastebin``, or
+view the whole thing syntax-highlighted with a single ``%pycat``.
+
+Traceback improvements
+======================
+
+
+UPDATE THIS IN INPUT.
+
+Previously, error tracebacks for errors happening in code cells were showing a hash, the one used for compiling the Python AST::
+
+    In [1]: def foo():
+    ...:     return 3 / 0
+    ...:
+
+    In [2]: foo()
+    ---------------------------------------------------------------------------
+    ZeroDivisionError                         Traceback (most recent call last)
+    <ipython-input-2-c19b6d9633cf> in <module>
+    ----> 1 foo()
+
+    <ipython-input-1-1595a74c32d5> in foo()
+        1 def foo():
+    ----> 2     return 3 / 0
+        3
+
+    ZeroDivisionError: division by zero
+
+The error traceback is now correctly formatted, showing the cell number in which the error happened::
+
+    In [1]: def foo():
+    ...:     return 3 / 0
+    ...:
+
+    In [2]: foo()
+    ---------------------------------------------------------------------------
+    ZeroDivisionError                         Traceback (most recent call last)
+    In [2], in <module>
+    ----> 1 foo()
+
+    In [1], in foo()
+        1 def foo():
+    ----> 2     return 3 / 0
+
+    ZeroDivisionError: division by zero
+
+Remove Deprecated Stuff
+=======================
+
+
+We no longer need to add `extensions` to the PYTHONPATH because that is being
+handled by `load_extension`.
+
+We are also removing Cythonmagic, sympyprinting and rmagic as they are now in
+other packages and no longer need to be inside IPython.
 
 .. DO NOT EDIT THIS LINE BEFORE RELEASE. FEATURE INSERTION POINT.
 

setup.cfg

@@ -101,7 +101,7 b' pygments.lexers ='
 
 [velin]
 ignore_patterns = 
-   IPython/core/tests,
+   IPython/core/tests
    IPython/testing
 
 [tool.black]