Show More
@@ -201,7 +201,9 b" def provisionalcompleter(action='ignore'):" | |||||
201 |
|
201 | |||
202 | >>> completer.do_experimental_things() # raises. |
|
202 | >>> completer.do_experimental_things() # raises. | |
203 |
|
203 | |||
204 |
.. note:: |
|
204 | .. note:: | |
|
205 | ||||
|
206 | Unstable | |||
205 |
|
207 | |||
206 | By using this context manager you agree that the API in use may change |
|
208 | By using this context manager you agree that the API in use may change | |
207 | without warning, and that you won't complain if they do so. |
|
209 | without warning, and that you won't complain if they do so. | |
@@ -356,7 +358,9 b' class Completion:' | |||||
356 | """ |
|
358 | """ | |
357 | Completion object used and return by IPython completers. |
|
359 | Completion object used and return by IPython completers. | |
358 |
|
360 | |||
359 |
.. warning:: |
|
361 | .. warning:: | |
|
362 | ||||
|
363 | Unstable | |||
360 |
|
364 | |||
361 | This function is unstable, API may change without warning. |
|
365 | This function is unstable, API may change without warning. | |
362 | It will also raise unless use in proper context manager. |
|
366 | It will also raise unless use in proper context manager. | |
@@ -419,7 +423,9 b' def _deduplicate_completions(text: str, completions: _IC)-> _IC:' | |||||
419 | """ |
|
423 | """ | |
420 | Deduplicate a set of completions. |
|
424 | Deduplicate a set of completions. | |
421 |
|
425 | |||
422 |
.. warning:: |
|
426 | .. warning:: | |
|
427 | ||||
|
428 | Unstable | |||
423 |
|
429 | |||
424 | This function is unstable, API may change without warning. |
|
430 | This function is unstable, API may change without warning. | |
425 |
|
431 | |||
@@ -459,7 +465,9 b' def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:' | |||||
459 | """ |
|
465 | """ | |
460 | Rectify a set of completions to all have the same ``start`` and ``end`` |
|
466 | Rectify a set of completions to all have the same ``start`` and ``end`` | |
461 |
|
467 | |||
462 |
.. warning:: |
|
468 | .. warning:: | |
|
469 | ||||
|
470 | Unstable | |||
463 |
|
471 | |||
464 | This function is unstable, API may change without warning. |
|
472 | This function is unstable, API may change without warning. | |
465 | It will also raise unless use in proper context manager. |
|
473 | It will also raise unless use in proper context manager. | |
@@ -1837,7 +1845,9 b' class IPCompleter(Completer):' | |||||
1837 | """ |
|
1845 | """ | |
1838 | Returns an iterator over the possible completions |
|
1846 | Returns an iterator over the possible completions | |
1839 |
|
1847 | |||
1840 |
.. warning:: |
|
1848 | .. warning:: | |
|
1849 | ||||
|
1850 | Unstable | |||
1841 |
|
1851 | |||
1842 | This function is unstable, API may change without warning. |
|
1852 | This function is unstable, API may change without warning. | |
1843 | It will also raise unless use in proper context manager. |
|
1853 | It will also raise unless use in proper context manager. |
@@ -1043,19 +1043,19 b' class Video(DisplayObject):' | |||||
1043 | ---------- |
|
1043 | ---------- | |
1044 | data : unicode, str or bytes |
|
1044 | data : unicode, str or bytes | |
1045 | The raw video data or a URL or filename to load the data from. |
|
1045 | The raw video data or a URL or filename to load the data from. | |
1046 | Raw data will require passing `embed=True`. |
|
1046 | Raw data will require passing ``embed=True``. | |
1047 | url : unicode |
|
1047 | url : unicode | |
1048 | A URL for the video. If you specify `url=`, |
|
1048 | A URL for the video. If you specify ``url=``, | |
1049 | the image data will not be embedded. |
|
1049 | the image data will not be embedded. | |
1050 | filename : unicode |
|
1050 | filename : unicode | |
1051 | Path to a local file containing the video. |
|
1051 | Path to a local file containing the video. | |
1052 | Will be interpreted as a local URL unless `embed=True`. |
|
1052 | Will be interpreted as a local URL unless ``embed=True``. | |
1053 | embed : bool |
|
1053 | embed : bool | |
1054 | Should the video be embedded using a data URI (True) or be |
|
1054 | Should the video be embedded using a data URI (True) or be | |
1055 | loaded using a <video> tag (False). |
|
1055 | loaded using a <video> tag (False). | |
1056 |
|
1056 | |||
1057 | Since videos are large, embedding them should be avoided, if possible. |
|
1057 | Since videos are large, embedding them should be avoided, if possible. | |
1058 | You must confirm embedding as your intention by passing `embed=True`. |
|
1058 | You must confirm embedding as your intention by passing ``embed=True``. | |
1059 |
|
1059 | |||
1060 | Local files can be displayed with URLs without embedding the content, via:: |
|
1060 | Local files can be displayed with URLs without embedding the content, via:: | |
1061 |
|
1061 | |||
@@ -1070,10 +1070,10 b' class Video(DisplayObject):' | |||||
1070 | Height in pixels to which to constrain the video in html. |
|
1070 | Height in pixels to which to constrain the video in html. | |
1071 | If not supplied, defaults to the height of the video. |
|
1071 | If not supplied, defaults to the height of the video. | |
1072 | html_attributes : str |
|
1072 | html_attributes : str | |
1073 | Attributes for the HTML `<video>` block. |
|
1073 | Attributes for the HTML ``<video>`` block. | |
1074 | Default: `"controls"` to get video controls. |
|
1074 | Default: ``"controls"`` to get video controls. | |
1075 | Other examples: `"controls muted"` for muted video with controls, |
|
1075 | Other examples: ``"controls muted"`` for muted video with controls, | |
1076 | `"loop autoplay"` for looping autoplaying video without controls. |
|
1076 | ``"loop autoplay"`` for looping autoplaying video without controls. | |
1077 |
|
1077 | |||
1078 | Examples |
|
1078 | Examples | |
1079 | -------- |
|
1079 | -------- |
General Comments 0
You need to be logged in to leave comments.
Login now