debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-25 04:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

notmuch_thread_get_authors: document match grouping with |

Browse source 
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.
This commit is contained in:
Gaute Hope 2014-09-10 09:24:18 +02:00 committed by David Bremner
parent 5c4f6ed99b
commit 2c9e120e0a
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/notmuch.h
View file

@ -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 * authors of mail messages in the query results that belong to this
* thread. * 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 * 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 * 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 * thread is valid, (which is until notmuch_thread_destroy or until