From: Jeff King <peff@peff.net>
Date: Thu, 23 May 2024 09:08:29 GMT
Subject: Re: [PATCH] blame: do not mention obvious default configuration values
Message-ID: <20240523090829.GD1306938@coredump.intra.peff.net>
In-Reply-To: <CAPig+cQ7bq8LKxnmjY3FQ9MRpM0GMep1Nxyp7jasB8yJvTV-RQ@mail.gmail.com>

On Wed, May 22, 2024 at 03:19:58PM -0400, Eric Sunshine wrote:

> For what it's worth, when reviewing patches on this list, I have
> multiple times asked submitters to mention the default value when
> adding new documentation since it saves users the trouble of having to
> discover the default either by experimentation or by reading the
> source code. So, I see removal of mention of default values as a step
> backward.

FWIW, I came here to make the same comment. ;) I'd rather the
documentation err on the side of being overly descriptive.

-Peff