diff --git a/jedi/__init__.py b/jedi/__init__.py index 9f8c3697..a9e4a2f8 100644 --- a/jedi/__init__.py +++ b/jedi/__init__.py @@ -1,3 +1,29 @@ +""" +Jedi is an autocompletion library for Python. It offers additonal +services such as goto / get_definition / pydoc support / +get_in_function_call / related names. + +To give you a simple exmple how you can use the jedi library, +here is an exmple for the autocompletion feature: + +>>> import jedi +>>> source = '''import json; json.l''' +>>> script = jedi.Script(source, 1, 19, '') +>>> script + +>>> completions = script.complete() +>>> completions +[, ] +>>> completions[0].complete +'oad' +>>> completions[0].word +'load' + +As you see Jedi is pretty simple and allows you to concentrate +writing a good text editor, while still having very good IDE features +for Python. +""" + import sys # python imports are hell sometimes. Especially the combination of relative @@ -9,8 +35,6 @@ from . import settings from . import api -__doc__ = api.__doc__ - del api sys.path.pop(0) diff --git a/jedi/api.py b/jedi/api.py index 35f60b46..1976310e 100644 --- a/jedi/api.py +++ b/jedi/api.py @@ -1,27 +1,5 @@ """ -Jedi is an autocompletion library for Python. It offers additonal -services such as goto / get_definition / pydoc support / -get_in_function_call / related names. - -To give you a simple exmple how you can use the jedi library, -here is an exmple for the autocompletion feature: - ->>> import jedi ->>> source = '''import json; json.l''' ->>> script = jedi.Script(source, 1, 19, '') ->>> script - ->>> completions = script.complete() ->>> completions -[, ] ->>> completions[0].complete -'oad' ->>> completions[0].word -'load' - -As you see Jedi is pretty simple and allows you to concentrate -writing a good text editor, while still having very good IDE features -for Python. +TODO doc """ from __future__ import with_statement __all__ = ['Script', 'NotFoundError', 'set_debug_function']