Re: DOCS - Server Applications [option] should be [option...]

From: Peter Smith <smithpb2250(at)gmail(dot)com>
To: Andreas Karlsson <andreas(at)proxel(dot)se>
Cc: PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS - Server Applications [option] should be [option...]
Date: 2026-02-18 09:05:54
Message-ID: CAHut+PsDXmrDLeEgszzH3QG_++z5sVbv1FcxbFsWt42TNmB3Og@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Wed, Feb 18, 2026 at 7:32 PM Andreas Karlsson <andreas(at)proxel(dot)se> wrote:
>
> On 2/17/26 2:08 AM, Peter Smith wrote:
> > Hi.
> >
> > Make the "option" part consistent in the synopses of all Server Applications:
> >
> > 1. "[option]" should be "[option...]"
>
> Agreed.
>
> > 2. It should be first
> I am not sure that is an improvement. I would rather move things with
> less signal towards the end. Also how many examples have we of each?
> Most seem to be on the format below which I feel indicates [option...]
> is last (but before order dependent arguments like dbname.)
>
> pg_dump [connection-option...] [option...] [dbname]
>

Thanks for the feedback

The scope of my patch is only the Server Applications [1]. Maybe it is
still correct that it is not much of an improvement, but you are
citing examples from Client Applications.

======
[1] https://www.postgresql.org/docs/devel/reference-server.html

Kind Regards,
Peter Smith.
Fujitsu Australia

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Dragos Andriciuc 2026-02-18 09:28:43 DOCS - Add introductory paragraph to Getting Started chapter
Previous Message Ants Aasma 2026-02-18 09:00:40 Re: client_connection_check_interval default value