X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=316385b84b435bdf696b95b7a046ca174c17ca1c;hb=f3fcdd2ddac2384c0c1daeffa495ad3ec01bc1af;hp=6a0e4c51f9362d18261b98e78190635fc6067038;hpb=74c4ce6d88bcc643424c5d89cc8d30cd835e46c3;p=notmuch

diff --git a/lib/notmuch.h b/lib/notmuch.h
index 6a0e4c51..316385b8 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -491,6 +491,9 @@ notmuch_database_load_config (const char *database_path,
  *
  * For description of arguments, @see notmuch_database_open_with_config
  *
+ * In case of any failure, this function returns an error status and
+ * sets *database to NULL.
+ *
  * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
  *
  * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created