lib: Correct out-of-date doc comment
authorAustin Clements <amdragon@MIT.EDU>
Mon, 12 Aug 2013 18:40:34 +0000 (14:40 -0400)
committerDavid Bremner <bremner@debian.org>
Tue, 13 Aug 2013 15:43:07 +0000 (17:43 +0200)
notmuch_message_get_header started returning some headers straight
from the database in 567bcbc, but this comment explicitly claimed all
headers were read from the message file.

lib/notmuch.h

index 73c85a41816c6386ad97d0f347ec6d06bafc0f71..9fc34ef13424ade22eb539b824316f91d4e01b50 100644 (file)
@@ -1015,8 +1015,11 @@ notmuch_message_get_date  (notmuch_message_t *message);
 
 /* Get the value of the specified header from 'message'.
  *
- * The value will be read from the actual message file, not from the
- * notmuch database. The header name is case insensitive.
+ * Common headers are stored in the database when the message is
+ * indexed and will be returned from the database.  Other headers will
+ * be read from the actual message file.
+ *
+ * The header name is case insensitive.
  *
  * The returned string belongs to the message so should not be
  * modified or freed by the caller (nor should it be referenced after