Re: [PATCH] doc: patch-id: convert to the modern synopsis style

From: Jeff King <peff@peff.net>
Date: Oct 10, 2025, 05:06 UTC
Message-ID: <20251010050628.GB1897715@coredump.intra.peff.net>
In-Reply-To: <978261e3be4.1760043036.git.code@khaugsbakk.name>

On Thu, Oct 09, 2025 at 10:53:53PM +0200, kristofferhaugsbakk@fastmail.com wrote:

Show 9 quoted lines

> 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).

-Peff