python: Add new functions in API documentation

Add documentation for the three new functions and add in which version
they have been added.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst
index d26a050157c9d088c72ae75080b247205ac137ce..012bef5019815a1cdfc13a0e71c22ef366d050e6 100644 (file)
--- a/bindings/python/docs/source/index.rst
+++ b/bindings/python/docs/source/index.rst
@@ -55,6 +55,10 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: upgrade
 
 
    .. automethod:: upgrade
 

+   .. automethod:: begin_atomic
+
+   .. automethod:: end_atomic
+

    .. automethod:: get_directory
 
    .. automethod:: add_message
    .. automethod:: get_directory
 
    .. automethod:: add_message


@@ -63,6 +67,8 @@ More information on specific topics can be found on the following pages:
 
    .. automethod:: find_message
 
 
    .. automethod:: find_message
 

+   .. automethod:: find_message_by_filename
+

    .. automethod:: get_all_tags
 
    .. automethod:: create_query
    .. automethod:: get_all_tags
 
    .. automethod:: create_query

diff --git a/bindings/python/notmuch/database.py b/bindings/python/notmuch/database.py
index c29ca6ee6e99e5b8772b017514c1ec56376294b2..1e6d33753ec725c123a55ed893c31675353a4368 100644 (file)
--- a/bindings/python/notmuch/database.py
+++ b/bindings/python/notmuch/database.py
@@ -224,10 +224,11 @@ class Database(object):
 
         :returns: :attr:`STATUS`.SUCCESS or raises
 
 
         :returns: :attr:`STATUS`.SUCCESS or raises
 

-        :exception: :exc:`NotmuchError` :attr:`STATUS`.XAPIAN_EXCEPTION::
+        :exception: :exc:`NotmuchError`:
+            :attr:`STATUS`.XAPIAN_EXCEPTION
+                Xapian exception occurred; atomic section not entered.

 
 

-                        A Xapian exception occurred; atomic section not
-                        entered."""
+        *Added in notmuch 0.9*"""

         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_begin_atomic(self._db)
         if status != STATUS.SUCCESS:
         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_begin_atomic(self._db)
         if status != STATUS.SUCCESS:


@@ -247,7 +248,9 @@ class Database(object):
                     A Xapian exception occurred; atomic section not
                     ended.
                 :attr:`STATUS`.UNBALANCED_ATOMIC:
                     A Xapian exception occurred; atomic section not
                     ended.
                 :attr:`STATUS`.UNBALANCED_ATOMIC:

-                    end_atomic has been called more times than begin_atomic."""
+                    end_atomic has been called more times than begin_atomic.
+
+        *Added in notmuch 0.9*"""

         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_end_atomic(self._db)
         if status != STATUS.SUCCESS:
         self._assert_db_is_initialized()
         status = nmlib.notmuch_database_end_atomic(self._db)
         if status != STATUS.SUCCESS:


@@ -431,7 +434,9 @@ class Database(object):
 
                 * No message is found with the given filename
                 * An out-of-memory situation occurs
 
                 * No message is found with the given filename
                 * An out-of-memory situation occurs

-                * A Xapian exception occurs"""
+                * A Xapian exception occurs
+
+        *Added in notmuch 0.9*"""

         self._assert_db_is_initialized()
         msg_p = Database._find_message_by_filename(self._db, _str(filename))
         return msg_p and Message(msg_p, self) or None
         self._assert_db_is_initialized()
         msg_p = Database._find_message_by_filename(self._db, _str(filename))
         return msg_p and Message(msg_p, self) or None