From ab7762f9e5538e402ccde8696701197405026295 2021-02-19 21:39:50 From: Matthias Bussonnier Date: 2021-02-19 21:39:50 Subject: [PATCH] fix doc --- diff --git a/IPython/core/completer.py b/IPython/core/completer.py index 0100bfc..78bc57e 100644 --- a/IPython/core/completer.py +++ b/IPython/core/completer.py @@ -201,7 +201,9 @@ def provisionalcompleter(action='ignore'): >>> completer.do_experimental_things() # raises. - .. note:: Unstable + .. note:: + + Unstable By using this context manager you agree that the API in use may change without warning, and that you won't complain if they do so. @@ -356,7 +358,9 @@ class Completion: """ Completion object used and return by IPython completers. - .. warning:: Unstable + .. warning:: + + Unstable This function is unstable, API may change without warning. It will also raise unless use in proper context manager. @@ -419,7 +423,9 @@ def _deduplicate_completions(text: str, completions: _IC)-> _IC: """ Deduplicate a set of completions. - .. warning:: Unstable + .. warning:: + + Unstable This function is unstable, API may change without warning. @@ -459,7 +465,9 @@ def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC: """ Rectify a set of completions to all have the same ``start`` and ``end`` - .. warning:: Unstable + .. warning:: + + Unstable This function is unstable, API may change without warning. It will also raise unless use in proper context manager. @@ -1837,7 +1845,9 @@ class IPCompleter(Completer): """ Returns an iterator over the possible completions - .. warning:: Unstable + .. warning:: + + Unstable This function is unstable, API may change without warning. It will also raise unless use in proper context manager. diff --git a/IPython/core/display.py b/IPython/core/display.py index ff59576..bd098e7 100644 --- a/IPython/core/display.py +++ b/IPython/core/display.py @@ -1043,19 +1043,19 @@ 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`. + Raw data will require passing ``embed=True``. url : unicode - A URL for the video. If you specify `url=`, + 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`. + 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