From d7e06b1d693b3a10ebca9fe3a0b663c40dc0f108 Mon Sep 17 00:00:00 2001 From: David Halter Date: Thu, 27 Dec 2012 19:18:38 +0100 Subject: [PATCH] add an api docstring again --- jedi/api.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/jedi/api.py b/jedi/api.py index 1976310e..3aaf8948 100644 --- a/jedi/api.py +++ b/jedi/api.py @@ -1,5 +1,8 @@ """ -TODO doc +The api basically only provides one class. You can create a ``Script`` and use +it's complete/goto/etc functions. Additionally you can add a debug function +with ``set_debug_function`` and catch ``NotFoundError``, which is being raised +if your completion is impossible. """ from __future__ import with_statement __all__ = ['Script', 'NotFoundError', 'set_debug_function']