mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-08 23:04:48 +08:00
Document utils.setup_readline
This commit is contained in:
@@ -28,6 +28,14 @@ def readline_complete(text, state):
|
|||||||
def setup_readline():
|
def setup_readline():
|
||||||
"""
|
"""
|
||||||
Install Jedi completer to :mod:`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:
|
try:
|
||||||
import readline
|
import readline
|
||||||
|
|||||||
Reference in New Issue
Block a user