notmuch_thread_get_authors: document match grouping with |
authorGaute Hope <eg@gaute.vetsj.com>
Wed, 10 Sep 2014 07:24:18 +0000 (09:24 +0200)
committerDavid Bremner <david@tethera.net>
Sat, 13 Sep 2014 06:43:35 +0000 (08:43 +0200)
commit2c9e120e0a2efef63dbd4ec9c4f24beb30ae9167
tree88212816b856a177cca74cd4f27838431029df9a
parent5c4f6ed99bd10fa26162c46601714141adeb3fb5
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.
lib/notmuch.h