summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonathan Slenders <jonathan@slenders.be>2016-12-29 22:12:29 +0100
committerJonathan Slenders <jonathan@slenders.be>2016-12-29 22:12:29 +0100
commitdfed263e958eda4f5bd642507f4b16bf64ffefc3 (patch)
treea217798f563f8ef58ac01c0c9ee809acf94e75b2
parentf69bc44bf92d041be5280d241ea39a12addede75 (diff)
Added example to PygmentsLexer docstring.
-rw-r--r--prompt_toolkit/layout/lexers.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/prompt_toolkit/layout/lexers.py b/prompt_toolkit/layout/lexers.py
index c94f256f..a928fd82 100644
--- a/prompt_toolkit/layout/lexers.py
+++ b/prompt_toolkit/layout/lexers.py
@@ -150,6 +150,17 @@ class PygmentsLexer(Lexer):
"""
Lexer that calls a pygments lexer.
+ Example::
+
+ from pygments.lexers import HtmlLexer
+ lexer = PygmentsLexer(HtmlLexer)
+
+ Note: Don't forget to also load a Pygments compatible style. E.g.::
+
+ from prompt_toolkit.styles.from_pygments import style_from_pygments
+ from pygments.styles import get_style_by_name
+ style = style_from_pygments(get_style_by_name('monokai'))
+
:param pygments_lexer_cls: A `Lexer` from Pygments.
:param sync_from_start: Start lexing at the start of the document. This
will always give the best results, but it will be slow for bigger