[PATCH] notmuch_thread_get_authors: document match grouping with |
Gaute Hope
eg at gaute.vetsj.com
Wed Sep 10 00:24:18 PDT 2014
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.
---
lib/notmuch.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 21a5225..fe2340b 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
--
2.1.0
More information about the notmuch
mailing list