From: rhn <gihu.rhn@porcupinefactory.org>
Date: Mon, 17 Dec 2018 17:57:48 +0000 (+0000)
Subject: docs: Use correct call to notmuch_query_search_threads in usage example
X-Git-Tag: archive/debian/0.29_rc0-1~142
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=fac155815cfaa3b151a196643c90f5a1820348e3

docs: Use correct call to notmuch_query_search_threads in usage example

Amended by db: simplify (subjectively) the example.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index aa032e09..24708f3c 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -889,10 +889,12 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
  *     notmuch_query_t *query;
  *     notmuch_threads_t *threads;
  *     notmuch_thread_t *thread;
+ *     notmuch_status_t stat;
  *
  *     query = notmuch_query_create (database, query_string);
  *
- *     for (threads = notmuch_query_search_threads (query);
+ *     for (stat = notmuch_query_search_threads (query, &threads);
+ *	    stat == NOTMUCH_STATUS_SUCCESS &&
  *          notmuch_threads_valid (threads);
  *          notmuch_threads_move_to_next (threads))
  *     {