Implement Message().get|set_flag()

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index f2b995a63ca6fb8062d548543ef111d92ccaf919..89b8d6c1029bffc77e8a7a2ad68fa8023633c934 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,7 +7,7 @@ Welcome to :mod:`cnotmuch`'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 classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Threads`, :class:`notmuch.Messages` and :class:`notmuch.Tags`.
 
 .. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
 
@@ -115,6 +115,9 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: count_messages
 
+.. #############################################
+.. currentmodule:: cnotmuch.message
+
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
@@ -137,7 +140,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 +172,9 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: __str__
 
+.. #############################################
+.. currentmodule:: cnotmuch.tag
+
 :class:`Tags` -- Notmuch tags
 -----------------------------
 
@@ -172,7 +186,7 @@ More information on specific topics can be found on the following pages:
    .. automethod:: __str__
 
 
-.. -----------------------------------------------------------------
+.. #############################################
 .. currentmodule:: cnotmuch.thread
 
 :class:`Threads` -- Threads iterator
@@ -209,6 +223,9 @@ More information on specific topics can be found on the following pages:
 
   .. automethod:: __str__
 
+.. #############################################
+.. currentmodule:: cnotmuch.notmuch
+
 :class:`Filenames` -- An iterator over filenames
 ------------------------------------------------