public inbox for [email protected]  
help / color / mirror / Atom feed
From: Daniel Gustafsson <[email protected]>
To: Peter Smith <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Subject: Re: DOCS - Server Applications [option] should be [option...]
Date: Mon, 23 Feb 2026 15:47:57 +0100
Message-ID: <[email protected]> (raw)
In-Reply-To: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@mail.gmail.com>
References: <CAHut+Ptqjj+cP+=U3u1+B2XUkFyt=3_GXmqCRepfRYDr7pqwSw@mail.gmail.com>

> On 17 Feb 2026, at 02:08, Peter Smith <[email protected]> wrote:

> Make the "option" part consistent in the synopses of all Server Applications:
> 
> 1. "[option]" should be "[option...]"

Only if the application can take multiple options.  pg_controldata can for
example only take a single parameter so [option] is correct there.

> 2. It should be first

Why?  I think it makes more sense to list [option...] after required parameters
just like how pg_upgrade does it.  We might not be consistent as is, but I'm
not sure it's a net improvement to always list it first as opposed to what we
have.

--
Daniel Gustafsson







view thread (2+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected], [email protected]
  Subject: Re: DOCS - Server Applications [option] should be [option...]
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox