From 27f8b342e1a4bea9c807b005d16f932880bb7136 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Sat, 18 May 2013 23:41:15 +0200 Subject: [PATCH] Document utils.setup_readline --- jedi/utils.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/jedi/utils.py b/jedi/utils.py index eb617fe7..24e1e5cb 100644 --- a/jedi/utils.py +++ b/jedi/utils.py @@ -28,6 +28,14 @@ def readline_complete(text, state): def setup_readline(): """ Install Jedi completer to :mod:`readline`. + + This function setups :mod:`readline` to use Jedi in Python interactive + shell. If you want to use custom ``PYTHONSTARTUP`` file, you can call + this function like this: + + >>> from jedi.utils import setup_readline + >>> setup_readline() + """ try: import readline