diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2013-06-24 14:46:05 +0100 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2013-07-07 18:06:18 +0100 |
| commit | 330e0542b6d1e32574b4c7561982f059a0b49de8 (patch) | |
| tree | 6a767759cee801d43cc0d0c3e9b86f2d380982da /docs/source | |
| parent | 2c6441e6af105868ec1d5af6dc82330ae217aa00 (diff) | |
doc: CompletionErrors
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/api/interface.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/source/api/interface.rst b/docs/source/api/interface.rst index 0ee0cb29..27ed06d5 100644 --- a/docs/source/api/interface.rst +++ b/docs/source/api/interface.rst @@ -107,11 +107,13 @@ of each other; the :class:`~alot.completion.QueryCompleter` for example uses a :class:`~alot.completion.TagsCompleter` internally to allow tagstring completion after "is:" or "tag:" keywords when typing a notmuch querystring. -All these classes overide the method :class:`~alot.completion.Completer.complete`, which +All these classes overide the method :meth:`~alot.completion.Completer.complete`, which for a given string and cursor position in that string returns a list of tuples `(completed_string, new_cursor_position)` that are taken to be the completed values. Note that `completed_string` does not need to have the original string as prefix. +:meth:`~alot.completion.Completer.complete` may rise :class:`alot.errors.CompletionError` +exceptions. .. automodule:: alot.completion :members: |