I'd also expect the commented examples to be in their section. I have just uncommented example lines in the past (in other softwares like SSH) when being first introduced to the software.

Being a comment, I see no downside on having the comment inside its section, and the upside is potentially less confusion and mistakes.

My 0.02

On March 13, 2026 2:17:56 AM GMT+01:00, David Bremner <david@tethera.net> wrote:
>Marc Haber <mh+debian-bugs@zugschlus.de> writes:
>
>>
>> I would find it more intuitive if it was formatted like:
>>
>> [database]
>> path=/home/mh/.mail
>>
>> [user]
>> # User configuration
>> #
>> # Here is where you can let notmuch know how you would like to be
>> # addressed. Valid settings are
>> #
>> #       name            Your full name.
>> #       primary_email   Your primary email address.
>> #       other_email     A list (separated by ';') of other email addresses
>> #                       at which you receive email.
>> #
>> # Notmuch will use the various email addresses configured here when
>> # formatting replies. It will avoid including your own addresses in the
>> # recipient list of replies, and will set the From address based on the
>> # address to which the original email was addressed.
>> #
>> primary_email=---
>>
>
>Your version looks OK to me, but honestly I never look at this file, so
>let's see if anyone else has opinions. The other question is how much
>control we have over the output. We're using `g_key_file_set_comment`,
>so this might be a glib feature request.
>
>d
>
>
>_______________________________________________
>notmuch mailing list -- notmuch@notmuchmail.org
>To unsubscribe send an email to notmuch-leave@notmuchmail.org