add an api docstring again

This commit is contained in:
David Halter
2012-12-27 19:18:38 +01:00
parent 464685f433
commit d7e06b1d69

View File

@@ -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']