Show More
@@ -193,7 +193,9 b" def provisionalcompleter(action='ignore'):" | |||||
193 |
|
193 | |||
194 | >>> completer.do_experimental_things() # raises. |
|
194 | >>> completer.do_experimental_things() # raises. | |
195 |
|
195 | |||
196 |
.. note:: |
|
196 | .. note:: | |
|
197 | ||||
|
198 | Unstable | |||
197 |
|
199 | |||
198 | By using this context manager you agree that the API in use may change |
|
200 | By using this context manager you agree that the API in use may change | |
199 | without warning, and that you won't complain if they do so. |
|
201 | without warning, and that you won't complain if they do so. | |
@@ -348,7 +350,9 b' class Completion:' | |||||
348 | """ |
|
350 | """ | |
349 | Completion object used and return by IPython completers. |
|
351 | Completion object used and return by IPython completers. | |
350 |
|
352 | |||
351 |
.. warning:: |
|
353 | .. warning:: | |
|
354 | ||||
|
355 | Unstable | |||
352 |
|
356 | |||
353 | This function is unstable, API may change without warning. |
|
357 | This function is unstable, API may change without warning. | |
354 | It will also raise unless use in proper context manager. |
|
358 | It will also raise unless use in proper context manager. | |
@@ -411,7 +415,9 b' def _deduplicate_completions(text: str, completions: _IC)-> _IC:' | |||||
411 | """ |
|
415 | """ | |
412 | Deduplicate a set of completions. |
|
416 | Deduplicate a set of completions. | |
413 |
|
417 | |||
414 |
.. warning:: |
|
418 | .. warning:: | |
|
419 | ||||
|
420 | Unstable | |||
415 |
|
421 | |||
416 | This function is unstable, API may change without warning. |
|
422 | This function is unstable, API may change without warning. | |
417 |
|
423 | |||
@@ -454,7 +460,9 b' def rectify_completions(text: str, completions: _IC, *, _debug=False)->_IC:' | |||||
454 | """ |
|
460 | """ | |
455 | Rectify a set of completions to all have the same ``start`` and ``end`` |
|
461 | Rectify a set of completions to all have the same ``start`` and ``end`` | |
456 |
|
462 | |||
457 |
.. warning:: |
|
463 | .. warning:: | |
|
464 | ||||
|
465 | Unstable | |||
458 |
|
466 | |||
459 | This function is unstable, API may change without warning. |
|
467 | This function is unstable, API may change without warning. | |
460 | It will also raise unless use in proper context manager. |
|
468 | It will also raise unless use in proper context manager. | |
@@ -1776,7 +1784,9 b' class IPCompleter(Completer):' | |||||
1776 | """ |
|
1784 | """ | |
1777 | Returns an iterator over the possible completions |
|
1785 | Returns an iterator over the possible completions | |
1778 |
|
1786 | |||
1779 |
.. warning:: |
|
1787 | .. warning:: | |
|
1788 | ||||
|
1789 | Unstable | |||
1780 |
|
1790 | |||
1781 | This function is unstable, API may change without warning. |
|
1791 | This function is unstable, API may change without warning. | |
1782 | It will also raise unless use in proper context manager. |
|
1792 | It will also raise unless use in proper context manager. |
@@ -1340,19 +1340,19 b' class Video(DisplayObject):' | |||||
1340 | ---------- |
|
1340 | ---------- | |
1341 | data : unicode, str or bytes |
|
1341 | data : unicode, str or bytes | |
1342 | The raw video data or a URL or filename to load the data from. |
|
1342 | The raw video data or a URL or filename to load the data from. | |
1343 | Raw data will require passing `embed=True`. |
|
1343 | Raw data will require passing ``embed=True``. | |
1344 | url : unicode |
|
1344 | url : unicode | |
1345 | A URL for the video. If you specify `url=`, |
|
1345 | A URL for the video. If you specify ``url=``, | |
1346 | the image data will not be embedded. |
|
1346 | the image data will not be embedded. | |
1347 | filename : unicode |
|
1347 | filename : unicode | |
1348 | Path to a local file containing the video. |
|
1348 | Path to a local file containing the video. | |
1349 | Will be interpreted as a local URL unless `embed=True`. |
|
1349 | Will be interpreted as a local URL unless ``embed=True``. | |
1350 | embed : bool |
|
1350 | embed : bool | |
1351 | Should the video be embedded using a data URI (True) or be |
|
1351 | Should the video be embedded using a data URI (True) or be | |
1352 | loaded using a <video> tag (False). |
|
1352 | loaded using a <video> tag (False). | |
1353 |
|
1353 | |||
1354 | Since videos are large, embedding them should be avoided, if possible. |
|
1354 | Since videos are large, embedding them should be avoided, if possible. | |
1355 | You must confirm embedding as your intention by passing `embed=True`. |
|
1355 | You must confirm embedding as your intention by passing ``embed=True``. | |
1356 |
|
1356 | |||
1357 | Local files can be displayed with URLs without embedding the content, via:: |
|
1357 | Local files can be displayed with URLs without embedding the content, via:: | |
1358 |
|
1358 | |||
@@ -1368,10 +1368,10 b' class Video(DisplayObject):' | |||||
1368 | Height in pixels to which to constrain the video in html. |
|
1368 | Height in pixels to which to constrain the video in html. | |
1369 | If not supplied, defaults to the height of the video. |
|
1369 | If not supplied, defaults to the height of the video. | |
1370 | html_attributes : str |
|
1370 | html_attributes : str | |
1371 | Attributes for the HTML `<video>` block. |
|
1371 | Attributes for the HTML ``<video>`` block. | |
1372 | Default: `"controls"` to get video controls. |
|
1372 | Default: ``"controls"`` to get video controls. | |
1373 | Other examples: `"controls muted"` for muted video with controls, |
|
1373 | Other examples: ``"controls muted"`` for muted video with controls, | |
1374 | `"loop autoplay"` for looping autoplaying video without controls. |
|
1374 | ``"loop autoplay"`` for looping autoplaying video without controls. | |
1375 |
|
1375 | |||
1376 | Examples |
|
1376 | Examples | |
1377 | -------- |
|
1377 | -------- |
General Comments 0
You need to be logged in to leave comments.
Login now