From cb19e5c382c243ad7109fa8ce254331cbc9b3b5f Mon Sep 17 00:00:00 2001 From: Patrick Totzke Date: Sun, 11 Mar 2012 18:19:18 +0000 Subject: docs: api of db submodule corrected --- docs/source/api/database.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) (limited to 'docs/source/api/database.rst') diff --git a/docs/source/api/database.rst b/docs/source/api/database.rst index 00334a4b..3f5e7d7c 100644 --- a/docs/source/api/database.rst +++ b/docs/source/api/database.rst @@ -5,16 +5,16 @@ Email Database The python bindings to libnotmuch define :class:`notmuch.Thread` and :class:`notmuch.Message`, which unfortunately are very fragile. -Alot defines the wrapper classes :class:`Thread` and :class:`~alot.message.Message` that +Alot defines the wrapper classes :class:`Thread` and :class:`~alot.db.message.Message` that use an :class:`DBManager` instance to transparently provide persistent objects. -:class:`~alot.message.Message` moreover contains convenience methods +:class:`~alot.db.message.Message` moreover contains convenience methods to extract information about the message like reformated header values, a summary, decoded and interpreted body text and a list of :class:`Attachments `. The central :class:`~alot.ui.UI` instance carries around a :class:`DBManager` object that is used for any lookups or modifications of the email base. :class:`DBManager` can -directly look up :class:`Thread` and :class:`~alot.message.Message` objects and is able to +directly look up :class:`Thread` and :class:`~alot.db.message.Message` objects and is able to postpone/cache/retry writing operations in case the Xapian index is locked by another process. @@ -25,23 +25,27 @@ Database Manager :members: -Exceptions +Errors ---------- + +.. module:: alot.db.errors + .. autoclass:: DatabaseError :members: .. autoclass:: DatabaseROError :members: .. autoclass:: DatabaseLockedError :members: +.. autoclass:: NonexistantObjectError + :members: Wrapper ------- -.. autoclass:: Thread +.. autoclass:: alot.db.thread.Thread :members: -.. module:: alot.message -.. autoclass:: Message +.. autoclass:: alot.db.message.Message :members: -- cgit v1.2.3