Re: [PATCH] blame: do not mention obvious default configuration values
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- May 22, 2024, 19:19 UTC
- Message-ID
- <CAPig+cQ7bq8LKxnmjY3FQ9MRpM0GMep1Nxyp7jasB8yJvTV-RQ@mail.gmail.com>
- In-Reply-To
- <51e30846c62a1605dee8fd5b9d096222@manjaro.org>
On Wed, May 22, 2024 at 3:13 PM Dragan Simic <dsimic@manjaro.org> wrote:
Show 14 quoted lines
> On 2024-05-22 20:44, Junio C Hamano wrote: > > diff --git a/Documentation/config/blame.txt > > b/Documentation/config/blame.txt > > @@ -1,6 +1,6 @@ > > blame.blankBoundary:: > > Show blank commit object name for boundary commits in > > - linkgit:git-blame[1]. This option defaults to false. > > + linkgit:git-blame[1]. > > @@ -14,11 +14,9 @@ blame.date:: > > Frankly, I'd much rather see the same "If true, ..." twist [1] > applied here, rather than just deleting the descriptions of the > defaults. To me, such an approach eliminates any doubts, while > not stressing out the actual default value.
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.