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

From: Andreas Karlsson <andreas(at)proxel(dot)se>
To: Peter Smith <smithpb2250(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: DOCS - Server Applications [option] should be [option...]
Date: 2026-02-18 08:32:22
Message-ID: 5678434a-568e-4c79-afc7-2a924c0235c4@proxel.se
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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]

Andreas

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Ajit Awekar 2026-02-18 08:38:32 Re: [OAuth2] Infrastructure for tracking token expiry time
Previous Message Nazir Bilal Yavuz 2026-02-18 08:31:37 Re: Improve docs syntax checking and enable it in the meson build