X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.h;h=f4e59ab2ca47f47df30c81fba7323f3605b0033f;hp=7e83d23941be6e9309e63b0edeed25f83da29640;hb=203a717d64864411eb6802c06a5a0ad1cf98e077;hpb=854f82fb91ef9560259e4597d475747e948204d5

diff --git a/notmuch.h b/notmuch.h
index 7e83d239..f4e59ab2 100644
--- a/notmuch.h
+++ b/notmuch.h
@@ -252,10 +252,11 @@ notmuch_database_get_timestamp (notmuch_database_t *database,
  * reference the filename, and will not copy the entire contents of
  * the file.
  *
- * If 'message' is not NULL, then '*message' will be initialized to a
- * message object that can be used for things such as adding tags to
- * the just-added message. The user should call
- * notmuch_message_destroy when done with the message.
+ * If 'message' is not NULL, then, on successful return '*message'
+ * will be initialized to a message object that can be used for things
+ * such as adding tags to the just-added message. The user should call
+ * notmuch_message_destroy when done with the message. On any failure
+ * '*message' will be set to NULL.
  *
  * Return value:
  *