From: rhn <gihu.rhn@porcupinefactory.org>
Date: Mon, 17 Dec 2018 17:57:46 +0000 (+0000)
Subject: lib: Explicitly state when replies will be destroyed
X-Git-Tag: archive/debian/0.29_rc0-1~144
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=45639881b5ddb56492bd3ba329e982517cc9ef54

lib: Explicitly state when replies will be destroyed

Without an explicit guarantee, it's not clear how to use the reference.
---

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 247f6ad7..aa032e09 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -1400,6 +1400,8 @@ notmuch_message_get_thread_id (notmuch_message_t *message);
  * If there are no replies to 'message', this function will return
  * NULL. (Note that notmuch_messages_valid will accept that NULL
  * value as legitimate, and simply return FALSE for it.)
+ *
+ * The returned list will be destroyed when the thread is destroyed.
  */
 notmuch_messages_t *
 notmuch_message_get_replies (notmuch_message_t *message);