summaryrefslogtreecommitdiff
path: root/docs/source/api/database.rst
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-03-11 18:19:18 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-03-11 18:19:53 +0000
commitcb19e5c382c243ad7109fa8ce254331cbc9b3b5f (patch)
treea0309717765ae60ad2d0343314548111f2dab278 /docs/source/api/database.rst
parenta5604af2e81033ceb076d36ba2ce675a3cdfa81f (diff)
docs: api of db submodule corrected
Diffstat (limited to 'docs/source/api/database.rst')
-rw-r--r--docs/source/api/database.rst18
1 files changed, 11 insertions, 7 deletions
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 <alot.message.Attachment>`.
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: