From: Austin Clements Date: Mon, 12 Aug 2013 18:40:34 +0000 (-0400) Subject: lib: Correct out-of-date doc comment X-Git-Tag: 0.17_rc1~201 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=a7bf045fb178b5ed48e71269427cec42c21f8cd6;p=notmuch.git lib: Correct out-of-date doc comment 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. --- diff --git a/lib/notmuch.h b/lib/notmuch.h index 73c85a41..9fc34ef1 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -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