From: Gaute Hope <eg@gaute.vetsj.com>
Date: Wed, 10 Sep 2014 07:24:18 +0000 (+0200)
Subject: notmuch_thread_get_authors: document match grouping with |
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2c9e120e0a2efef63dbd4ec9c4f24beb30ae9167;p=notmuch.git

notmuch_thread_get_authors: document match grouping with |

as stated in thread.cc:115

/* Construct an authors string from matched_authors_array and
 * authors_array. The string contains matched authors first, then
 * non-matched authors (with the two groups separated by '|'). Within
 * each group, authors are listed in date order. */

this is, however, not reflected in the public API documentation in
notmuch.h:970. This patch a paragraph explaining how | separates the
group of authors of messages matching the query and those of messages
that do not, but are still contained in the thread.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 21a52252..fe2340bb 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -973,6 +973,10 @@ notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
  * authors of mail messages in the query results that belong to this
  * thread.
  *
+ * The string contains authors of messages matching the query first, then
+ * non-matched authors (with the two groups separated by '|'). Within
+ * each group, authors are ordered by date.
+ *
  * The returned string belongs to 'thread' and as such, should not be
  * modified by the caller and will only be valid for as long as the
  * thread is valid, (which is until notmuch_thread_destroy or until