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

On Sat, Oct 16, 2021 at 11:14:46AM +0900, Michael Paquier wrote:
> 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, perhaps I mistake you; it seems you would like it better with
the extra '[' before OWNER.  That would more accurately point up

    CREATE DATABASE name WITH;

Either way, my argument would have the basis.

In what sense are the options a single group?  That they all might
follow the 'WITH' is expressed without the duplicated brackets.
That the extra braces promote readability relies on an assumption or
knowledge of the command.

Given that 'optional, optional' has no independent meaning from
'optional';  it requires one to scan the entire set looking for
the non-optional embedded in the option.  So no gain.

Rob








view thread (5+ messages)  latest in thread

Message-ID: <20211016171149.yaouvlw5kvux6dvk@localhost>
Permalink:  ../20211016171149.yaouvlw5kvux6dvk@localhost/
Also on:    postgresql.org/message-id/20211016171149.yaouvlw5kvux6dvk@localhost

 · 

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: rirans@comcast.net, pgsql-hackers@lists.postgresql.org
  Subject: Re: Trivial doc patch
  In-Reply-To: <20211016171149.yaouvlw5kvux6dvk@localhost>

* 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