git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] blame: do not mention obvious default configuration values

From
Jeff King <peff@peff.net>
Date
May 23, 2024, 09:08 UTC
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:
Show 6 quoted lines
> 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
Previous: Eric Sunshine
Message 4 of 4 in “blame: do not mention obvious default configuration values”
  1. blame: do not mention obvious default configuration valuesJunio C Hamano, May 22, 2024
  2. Dragan SimicMay 22, 2024
  3. Eric SunshineMay 22, 2024
  4. Jeff KingMay 23, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.