From 902faaab19b96018fbf13a0816672550fbefd722 2018-01-11 16:38:49 From: Thomas Kluyver Date: 2018-01-11 16:38:49 Subject: [PATCH] Docstring for Code class --- diff --git a/IPython/lib/display.py b/IPython/lib/display.py index 21aa54b..7263e29 100644 --- a/IPython/lib/display.py +++ b/IPython/lib/display.py @@ -558,6 +558,23 @@ class FileLinks(FileLink): class Code(TextDisplayObject): + """Display syntax-highlighted source code. + + This uses Pygments to highlight the code for HTML and Latex output. + + Parameters + ---------- + data : str + The code as a string + url : str + A URL to fetch the code from + filename : str + A local filename to load the code from + language : str + The short name of a Pygments lexer to use for highlighting. + If not specified, it will guess the lexer based on the filename + or the code. Available lexers: http://pygments.org/docs/lexers/ + """ def __init__(self, data=None, url=None, filename=None, language=None): self.language = language super().__init__(data=data, url=url, filename=filename)