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 247f6ad71ebf1223b32f1c2b5e226261a309ffc1..aa032e092e9b1b396d77309e4e25b54e1edde135 100644 (file)
--- 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);