From: Carl Worth <cworth@cworth.org>
Date: Sat, 24 Apr 2010 14:24:01 +0000 (-0700)
Subject: lib: Document that notmuch_query_count_messages may return 0 if an exception occurs
X-Git-Tag: 0.3~72
X-Git-Url: https://git.cworth.org/git?a=commitdiff_plain;h=e3e0e26806cf95cddd4dfb11c24d1ecd15171110;hp=9ef68f1444de981c47af06c948e3aa3ca5a377c8;p=obsolete%2Fnotmuch-old

lib: Document that notmuch_query_count_messages may return 0 if an exception occurs

This isn't a behavioral change---just a calrification in the documentation.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 921b0fcf..54616336 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -506,6 +506,9 @@ notmuch_threads_destroy (notmuch_threads_t *threads);
  *
  * This function performs a search and returns Xapian's best
  * guess as to number of matching messages.
+ *
+ * If a Xapian exception occurs, this function may return 0 (after
+ * printing a message).
  */
 unsigned
 notmuch_query_count_messages (notmuch_query_t *query);