aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorGravatar Carl Worth <cworth@cworth.org>2010-04-24 07:24:01 -0700
committerGravatar Carl Worth <cworth@cworth.org>2010-04-24 07:27:50 -0700
commite3e0e26806cf95cddd4dfb11c24d1ecd15171110 (patch)
tree32312cf48f4093d93ba92bc8c2246f1c98f7917c /lib/notmuch.h
parent9ef68f1444de981c47af06c948e3aa3ca5a377c8 (diff)
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.
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h3
1 files changed, 3 insertions, 0 deletions
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);