From 6d4fced2f1c56d709042ac35e8523b57cc57f454 2021-01-29 23:32:49 From: Matthias Bussonnier Date: 2021-01-29 23:32:49 Subject: [PATCH] Update some docstring to conform to numpy docstring format --- diff --git a/IPython/core/display.py b/IPython/core/display.py index 2920b84..d2c13e3 100644 --- a/IPython/core/display.py +++ b/IPython/core/display.py @@ -851,18 +851,26 @@ class Image(DisplayObject): Examples -------- - # embedded image data, works in qtconsole and notebook - # when passed positionally, the first arg can be any of raw image data, - # a URL, or a filename from which to load image data. - # The result is always embedding image data for inline images. - Image('http://www.google.fr/images/srpr/logo3w.png') - Image('/path/to/image.jpg') - Image(b'RAW_PNG_DATA...') - - # Specifying Image(url=...) does not embed the image data, - # it only generates `` tag with a link to the source. - # This will not work in the qtconsole or offline. - Image(url='http://www.google.fr/images/srpr/logo3w.png') + + embedded image data, works in qtconsole and notebook + when passed positionally, the first arg can be any of raw image data, + a URL, or a filename from which to load image data. + The result is always embedding image data for inline images. + + >>> Image('http://www.google.fr/images/srpr/logo3w.png') + + + >>> Image('/path/to/image.jpg') + + + >>> Image(b'RAW_PNG_DATA...') + + + Specifying Image(url=...) does not embed the image data, + it only generates ```` tag with a link to the source. + This will not work in the qtconsole or offline. + + >>> Image(url='http://www.google.fr/images/srpr/logo3w.png') """ if isinstance(data, (Path, PurePath)): diff --git a/IPython/lib/display.py b/IPython/lib/display.py index 09268ad..e8b8a44 100644 --- a/IPython/lib/display.py +++ b/IPython/lib/display.py @@ -70,13 +70,13 @@ class Audio(DisplayObject): ... framerate = 44100 ... t = np.linspace(0,5,framerate*5) ... data = np.sin(2*np.pi*220*t) + np.sin(2*np.pi*224*t) - ... Audio(data,rate=framerate) + ... Audio(data, rate=framerate) Can also do stereo or more channels >>> dataleft = np.sin(2*np.pi*220*t) ... dataright = np.sin(2*np.pi*224*t) - ... Audio([dataleft, dataright],rate=framerate) + ... Audio([dataleft, dataright], rate=framerate) From URL: