reply: Document the reason for g_mime_filter_headers

Given how long it took me to figure out why we pass the reply headers
through g_mime_filter_headers, it's worth a comment.

diff --git a/notmuch-reply.c b/notmuch-reply.c
index e151f78a79a406b695da6cf7feeca7917facbc2a..3b2b58d194dfb8f1be470dfd6d04fbf2393af45c 100644 (file)
--- a/notmuch-reply.c
+++ b/notmuch-reply.c
@@ -34,6 +34,10 @@ show_reply_headers (GMimeMessage *message)
        g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
        stream_filter = g_mime_stream_filter_new(stream_stdout);
        if (stream_filter) {
+               // g_mime_object_write_to_stream will produce
+               // RFC2047-encoded headers, but we want to present the
+               // user with decoded headers and let whatever
+               // ultimately sends the mail do the RFC2047 encoding.
                g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
                                         g_mime_filter_headers_new());
                g_mime_object_write_to_stream(GMIME_OBJECT(message), stream_filter);