docs: stub out remaining missing bindings to get a reminder

[notmuch] / docs / source / index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index d6f9411dabbf162bf34df9a7ecb8eec233d82bd6..6d0d5fa3f99165dbb1efb7ecc32b69215e38694d 100644 (file)
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -45,6 +45,18 @@ or::
 
    .. automethod:: get_path
 
+   .. automethod:: get_version
+
+   .. automethod:: needs_upgrade
+
+   .. automethod:: upgrade
+
+   .. automethod:: get_directory
+
+   .. automethod:: add_message
+
+   .. automethod:: remove_message
+
    .. automethod:: find_message
 
    .. automethod:: get_all_tags
@@ -62,33 +74,109 @@ or::
 
    .. autoattribute:: db_p
 
-:class:`Query` -- Represents a notmuch Query
+:class:`Query` -- A search query
 -----------------------------------------------
 
 .. autoclass:: Query
-   :members:
+
+   .. automethod:: create
+
+   .. attribute:: Query.SORT
+
+     Defines constants that are used as the mode in which to open a database.
+
+     SORT.OLDEST_FIRST
+       Sort by message date, oldest first.
+
+     SORT.NEWEST_FIRST
+       Sort by message date, newest first.
+
+     SORT.MESSAGE_ID
+       Sort by email message ID
+
+   .. automethod:: set_sort
+
+   .. automethod:: search_threads
+
+   .. automethod:: search_messages
+
+   .. automethod:: count_messages
 
 :class:`Messages` -- A bunch of messages
 ----------------------------------------
 
 .. autoclass:: Messages
-   :members:
+
+   .. automethod:: collect_tags
+
+   .. automethod:: __len__
 
 :class:`Message` -- A single message
 ----------------------------------------
 
 .. autoclass:: Message
-   :members:
 
-:class:`Tags` -- A bunch of notmuch tags
-----------------------------------------
+   .. automethod:: get_message_id
+
+   .. automethod:: get_thread_id
+
+   .. automethod:: get_replies
+
+   .. automethod:: get_filename
+
+   .. automethod:: get_flag
+
+   .. automethod:: set_flag
+   
+   .. automethod:: get_date
+
+   .. automethod:: get_header
+
+   .. automethod:: get_tags
+
+   .. automethod:: remove_tag
+
+   .. automethod:: add_tag
+
+   .. automethod:: remove_all_tags
+
+   .. automethod:: freeze
+
+   .. automethod:: thaw
+
+   .. automethod:: format_as_text
+
+   .. automethod:: __str__
+
+:class:`Tags` -- Notmuch tags
+-----------------------------
 
 .. autoclass:: Tags
    :members:
 
-   .. data: '__notmuchcmd__'
+   .. automethod:: __len__
+
+   .. automethod:: __str__
+
+:class:`Threads` -- Threads iterator
+------------------------------------
+
+To be implemented
+
+:class:`Thread` -- A single thread
+------------------------------------
+
+To be implemented
 
-      This is the actual binary that will be executed in order to run a notmuch command. This is set to *notmuch* and should usually not be changed.
+:class:`Filenames` -- An iterator over filenames
+------------------------------------------------
+
+To be implemented
+
+:class:`Directoy` -- A directory entry in the database
+------------------------------------------------------
+
+To be implemented
 
 :exc:`NotmuchError` -- A Notmuch execution error
 ------------------------------------------------
@@ -100,7 +188,8 @@ or::
 :class:`STATUS` -- Notmuch operation return status
 --------------------------------------------------
 .. autoclass:: STATUS
-   :members:
+
+   To be documented
 
 Indices and tables
 ==================