python: adapt docs to the notmuch module renaming

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index f2b995a63ca6fb8062d548543ef111d92ccaf919..c90492c8b674ce99a7683c42c8d1fc4f66881548 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,27 +1,27 @@
-.. cnotmuch documentation master file, created by
+.. notmuch documentation master file, created by
    sphinx-quickstart on Tue Feb  2 10:00:47 2010.
 
-.. currentmodule:: cnotmuch
+.. currentmodule:: notmuch
 
-Welcome to :mod:`cnotmuch`'s documentation
+Welcome to :mod:`notmuch`'s documentation
 ===========================================
 
-The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
-The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Messages` and :class:`notmuch.Tags`.
+The :mod:`notmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
+Within :mod:`notmuch`, the classes :class:`Database`, :class:`Query` provide most of the core functionality, returning :class:`Threads`, :class:`Messages` and :class:`Tags`.
 
 .. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
 
 :License: This module is covered under the GNU GPL v3 (or later).
 
-This page contains the main API overview of cnotmuch |release|. 
+This page contains the main API overview of notmuch |release|. 
 
 Notmuch can be imported as::
 
- from cnotmuch import notmuch
+ import notmuch
 
 or::
 
- from cnotmuch.notmuch import Query,Database
+ from notmuch import Query,Database
 
 More information on specific topics can be found on the following pages:
 
@@ -31,16 +31,16 @@ More information on specific topics can be found on the following pages:
    notmuch   
 
 :mod:`notmuch` -- The Notmuch interface
-=============================================
+=================================================
 
-.. automodule:: cnotmuch.notmuch
+.. automodule:: notmuch
 
 :todo: Document nmlib,STATUS
 
-:class:`Database` -- The underlying notmuch database
------------------------------------------------------
+:class:`notmuch.Database` -- The underlying notmuch database
+---------------------------------------------------------------------
 
-.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
+.. autoclass:: notmuch.Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
 
    .. automethod:: create
 
@@ -81,10 +81,10 @@ More information on specific topics can be found on the following pages:
 
    .. autoattribute:: db_p
 
-:class:`Query` -- A search query
------------------------------------------------
+:class:`notmuch.Query` -- A search query
+-------------------------------------------------
 
-.. autoclass:: Query
+.. autoclass:: notmuch.Query
 
    .. automethod:: create
 
@@ -115,6 +115,7 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: count_messages
 
+
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
@@ -137,7 +138,15 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: get_filename
 
-   .. automethod:: get_flag
+   .. attribute:: FLAG
+
+        FLAG.MATCH 
+          This flag is automatically set by a
+         Query.search_threads on those messages that match the
+         query. This allows us to distinguish matches from the rest
+         of the messages in that thread.
+
+  .. automethod:: get_flag
 
    .. automethod:: set_flag
    
@@ -161,6 +170,7 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: __str__
 
+
 :class:`Tags` -- Notmuch tags
 -----------------------------
 
@@ -172,13 +182,10 @@ More information on specific topics can be found on the following pages:
    .. automethod:: __str__
 
 
-.. -----------------------------------------------------------------
-.. currentmodule:: cnotmuch.thread
-
-:class:`Threads` -- Threads iterator
-------------------------------------
+:class:`notmuch.Threads` -- Threads iterator
+-----------------------------------------------------
 
-.. autoclass:: Threads
+.. autoclass:: notmuch.Threads
 
    .. automethod:: __len__
 
@@ -209,15 +216,30 @@ More information on specific topics can be found on the following pages:
 
   .. automethod:: __str__
 
+
 :class:`Filenames` -- An iterator over filenames
 ------------------------------------------------
 
-To be implemented
+.. autoclass:: notmuch.database.Filenames
+
+   .. automethod:: notmuch.database.Filenames.__len__
 
-:class:`Directoy` -- A directory entry in the database
-------------------------------------------------------
+:class:`notmuch.database.Directoy` -- A directory entry in the database
+------------------------------------------------------------------------
 
-To be implemented
+.. autoclass:: notmuch.database.Directory
+
+   .. automethod:: notmuch.database.Directory.get_child_files
+
+   .. automethod:: notmuch.database.Directory.get_child_directories
+
+   .. automethod:: notmuch.database.Directory.get_mtime
+
+   .. automethod:: notmuch.database.Directory.set_mtime
+
+   .. autoattribute:: notmuch.database.Directory.mtime
+
+   .. autoattribute:: notmuch.database.Directory.path
 
 :exc:`NotmuchError` -- A Notmuch execution error
 ------------------------------------------------
@@ -228,9 +250,23 @@ To be implemented
 
 :class:`STATUS` -- Notmuch operation return status
 --------------------------------------------------
-.. autoclass:: STATUS
 
-   To be documented
+.. data:: STATUS
+
+  STATUS is a class, whose attributes provide constants that serve as return indicators for notmuch functions. Currently the following ones are defined. For possible return values and specific meaning for each method, see the method description.
+
+  * SUCCESS
+  * OUT_OF_MEMORY
+  * READ_ONLY_DATABASE
+  * XAPIAN_EXCEPTION
+  * FILE_ERROR
+  * FILE_NOT_EMAIL
+  * DUPLICATE_MESSAGE_ID
+  * NULL_POINTER
+  * TAG_TOO_LONG
+  * UNBALANCED_FREEZE_THAW
+  * NOT_INITIALIZED
+
 
 Indices and tables
 ==================