pg.ddx.io  pgsql-hackers@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Michael Paquier <michael@paquier.xyz>
To: rir <rirans@comcast.net>
Cc: pgsql-hackers@lists.postgresql.org
Subject: Re: Trivial doc patch
Date: Sat, 16 Oct 2021 11:14:46 +0900
Message-ID: <YWo1lgOQ0P1eUqqC@paquier.xyz> (raw)
In-Reply-To: <20211015171314.p7v4vygabwhh7ihc@localhost>
References: <20211015171314.p7v4vygabwhh7ihc@localhost>

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

Attachments:

  signature.asc (application/pgp-signature, 832B) download

view thread (5+ messages)  latest in thread

Message-ID: <YWo1lgOQ0P1eUqqC@paquier.xyz>
Permalink:  ../YWo1lgOQ0P1eUqqC@paquier.xyz/
Also on:    postgresql.org/message-id/YWo1lgOQ0P1eUqqC@paquier.xyz

 · 

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: pgsql-hackers@postgresql.org
  Cc: michael@paquier.xyz, rirans@comcast.net, pgsql-hackers@lists.postgresql.org
  Subject: Re: Trivial doc patch
  In-Reply-To: <YWo1lgOQ0P1eUqqC@paquier.xyz>

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

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