Re: Trivial doc patch - Mailing list pgsql-hackers

From Michael Paquier
Subject Re: Trivial doc patch
Date
Msg-id YWo1lgOQ0P1eUqqC@paquier.xyz
Whole thread Raw
In response to Trivial doc patch  (rir <rirans@comcast.net>)
Responses Re: Trivial doc patch  (rir <rirans@comcast.net>)
List pgsql-hackers
On Fri, Oct 15, 2021 at 01:13:14PM -0400, rir wrote:
> This removes the outer square brackets in the create_database.sgml
> file's synopsis.  In the command sysopses, this is the only case
> where an optional group contains only optional groups.
>
>  CREATE DATABASE <replaceable class="parameter">name</replaceable>
> -    [ [ WITH ] [ OWNER [=] <replaceable class="parameter">user_name</replaceable> ]
> +    [ WITH ] [ OWNER [=] <replaceable class="parameter">user_name</replaceable> ]
> [...]
> -           [ IS_TEMPLATE [=] <replaceable class="parameter">istemplate</replaceable> ] ]
> +           [ IS_TEMPLATE [=] <replaceable class="parameter">istemplate</replaceable> ]
>  </synopsis>
>   </refsynopsisdiv>

You are not wrong, and the existing doc is not wrong either.  I tend
to prefer the existing style, though, as it insists on the options
as being a single group, with or without the keyword WITH.
--
Michael

Attachment

pgsql-hackers by date:

Previous
From: Tom Lane
Date:
Subject: pg_dump fails to lock partitioned tables
Next
From: Michael Paquier
Date:
Subject: Re: Reset snapshot export state on the transaction abort