From: Kristoffer Haugsbakk <code@khaugsbakk.name>
Date: Mon, 13 Oct 2025 15:03:43 GMT
Subject: Re: [PATCH] doc: patch-id: convert to the modern synopsis style
Message-ID: <932d3fd8-7fd3-4d1c-b3a7-644fb04ef47d@app.fastmail.com>
In-Reply-To: <20251010050628.GB1897715@coredump.intra.peff.net>

On Fri, Oct 10, 2025, at 07:06, Jeff King wrote:
> On Thu, Oct 09, 2025 at 10:53:53PM +0200,
> kristofferhaugsbakk@fastmail.com wrote:
>
>> Convert this command documentation to the modern synopsis style based on
>> similar work.[1] Concretely:
>>
>> • Change the Synopsis section from `verse` to a `synopsis` block which
>>   will automatically apply the correct formatting to various elements
>>   (although this Synopsis is very simple)
>> • Use backticks (`) for code-like things which will also use the correct
>>   formatting for interior placeholders (`<orderfile>`)
>> • Use backticks on options
>
> These all look like strict improvements to me. Sadly doc-diff doesn't
> show much here because the changes are mostly typographical, so I
> eyeballed the HTML output (which does look much nicer).

Thanks for testing!

-- 
Kristoffer