Implement Message().get|set_flag()

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 468a3c911cb34b910328345d75c018c9354c6de5..89b8d6c1029bffc77e8a7a2ad68fa8023633c934 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,13 +7,13 @@ 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>
 
 :License: This module is covered under the GNU GPL v3 (or later).
 
-This page contains the main API overview of cnotmuch |release|. More information on specific topics can be found on the following pages: (none here yet)
+This page contains the main API overview of cnotmuch |release|. 
 
 Notmuch can be imported as::
 
@@ -23,9 +23,12 @@ or::
 
  from cnotmuch.notmuch import Query,Database
 
+More information on specific topics can be found on the following pages:
+
 .. toctree::
    :maxdepth: 1
 
+   notmuch   
 
 :mod:`notmuch` -- The Notmuch interface
 =============================================
@@ -63,6 +66,9 @@ or::
 
    .. automethod:: create_query
 
+   .. note:: :meth:`create_query` was broken in release
+             0.1 and is fixed since 0.1.1.
+
    .. attribute:: Database.MODE
 
      Defines constants that are used as the mode in which to open a database.
@@ -97,12 +103,21 @@ or::
 
    .. automethod:: set_sort
 
+   .. attribute::  sort
+
+      Instance attribute :attr:`sort` contains the sort order (see
+      :attr:`Query.SORT`) if explicitely specified via
+      :meth:`set_sort`. By default it is set to `None`.
+
    .. automethod:: search_threads
 
    .. automethod:: search_messages
 
    .. automethod:: count_messages
 
+.. #############################################
+.. currentmodule:: cnotmuch.message
+
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
@@ -125,7 +140,15 @@ or::
 
    .. 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
    
@@ -149,6 +172,9 @@ or::
 
    .. automethod:: __str__
 
+.. #############################################
+.. currentmodule:: cnotmuch.tag
+
 :class:`Tags` -- Notmuch tags
 -----------------------------
 
@@ -159,15 +185,46 @@ or::
 
    .. automethod:: __str__
 
+
+.. #############################################
+.. currentmodule:: cnotmuch.thread
+
 :class:`Threads` -- Threads iterator
 ------------------------------------
 
-To be implemented
+.. autoclass:: Threads
+
+   .. automethod:: __len__
+
+   .. automethod:: __str__
 
 :class:`Thread` -- A single thread
 ------------------------------------
 
-To be implemented
+.. autoclass:: Thread
+
+  .. automethod:: get_thread_id
+
+  .. automethod:: get_total_messages
+
+  .. automethod:: get_toplevel_messages
+
+  .. automethod:: get_matched_messages
+
+  .. automethod:: get_authors
+
+  .. automethod:: get_subject
+
+  .. automethod:: get_oldest_date
+
+  .. automethod:: get_newest_date
+
+  .. automethod:: get_tags
+
+  .. automethod:: __str__
+
+.. #############################################
+.. currentmodule:: cnotmuch.notmuch
 
 :class:`Filenames` -- An iterator over filenames
 ------------------------------------------------