From: Jeff King <peff@peff.net>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Dragan Simic <dsimic@manjaro.org>,
Junio C Hamano <gitster@pobox.com>,
git@vger.kernel.org
Subject: Re: [PATCH] blame: do not mention obvious default configuration values
Date: Thu, 23 May 2024 05:08:29 -0400 [thread overview]
Message-ID: <20240523090829.GD1306938@coredump.intra.peff.net> (raw)
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
prev parent reply other threads:[~2024-05-23 9:08 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-22 18:44 [PATCH] blame: do not mention obvious default configuration values Junio C Hamano
2024-05-22 19:13 ` Dragan Simic
2024-05-22 19:19 ` Eric Sunshine
2024-05-23 9:08 ` Jeff King [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240523090829.GD1306938@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=dsimic@manjaro.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).