Improve source documentation

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index e48c345a2ab8beeecf8e3799c22c30b05a230f46..06f21422f14a14700cff0014061b10d81f182664 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -31,13 +31,35 @@ or:
 :mod:`notmuch` -- The Notmuch interface
 =============================================
 
-Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
+Document from cnotmuch.globals import nmlib,STATUS
 
 :class:`Database` -- The underlying notmuch database
 -----------------------------------------------------
 
-.. autoclass:: Database
-   :members:
+.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
+
+   .. automethod:: create
+
+   .. automethod:: open(path, status=MODE.READ_ONLY)
+
+   .. automethod:: get_path
+
+   .. automethod:: find_message
+
+   .. automethod:: get_all_tags
+
+
+   .. attribute:: Database.MODE
+
+     Defines constants that are used as the mode in which to open a database.
+
+     READ_ONLY
+       Open the database in read-only mode
+
+     READ_WRITE
+       Open the database in read-write mode
+
+   .. autoattribute:: db_p
 
 :class:`Query` -- Represents a notmuch Query
 -----------------------------------------------
@@ -45,8 +67,6 @@ Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
 .. autoclass:: Query
    :members:
 
-   .. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
-
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
@@ -76,6 +96,11 @@ Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
 
    This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
 
+:class:`STATUS` -- Notmuch operation return status
+--------------------------------------------------
+.. autoclass:: STATUS
+   :members:
+
 Indices and tables
 ==================