Re: Trivial doc patch
On Fri, Aug 19, 2022 at 10:42:45AM -0400, Bruce Momjian wrote: > > 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. > > I originally had the same reaction Michael Paquier did, that having one > big optional block is nice, but seeing that 'CREATE DATABASE name WITH' > actually works, I can see the point in having our syntax be accurate, > and removing the outer optional brackets now does seem like an > improvement to me. Backpatched to PG 10. Thanks. -- Bruce Momjian https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson
Re: Trivial doc patch
On Sat, Oct 16, 2021 at 01:11:49PM -0400, rir wrote: > 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 name > > > -[ [ WITH ] [ OWNER [=] > > class="parameter">user_name ] > > > +[ WITH ] [ OWNER [=] > > class="parameter">user_name ] > > > [...] > > > - [ IS_TEMPLATE [=] > > class="parameter">istemplate ] ] > > > + [ IS_TEMPLATE [=] > > class="parameter">istemplate ] > > > > > > > > > > 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. I originally had the same reaction Michael Paquier did, that having one big optional block is nice, but seeing that 'CREATE DATABASE name WITH' actually works, I can see the point in having our syntax be accurate, and removing the outer optional brackets now does seem like an improvement to me. Attached is the proposed change. -- Bruce Momjian https://momjian.us EDB https://enterprisedb.com Indecision is a decision. Inaction is an action. Mark Batterson diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 0b32e7ecf9..0ce0bd8a1a 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -22,7 +22,7 @@ PostgreSQL documentation CREATE DATABASE name -[ [ WITH ] [ OWNER [=] user_name ] +[ WITH ] [ OWNER [=] user_name ] [ TEMPLATE [=] template ] [ ENCODING [=] encoding ] [ STRATEGY [=] strategy ] ] @@ -36,7 +36,7 @@ CREATE DATABASE name [ ALLOW_CONNECTIONS [=] allowconn ] [ CONNECTION LIMIT [=] connlimit ] [ IS_TEMPLATE [=] istemplate ] - [ OID [=] oid ] ] + [ OID [=] oid ]
Re: Trivial doc patch
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 name > > -[ [ WITH ] [ OWNER [=] > class="parameter">user_name ] > > +[ WITH ] [ OWNER [=] > class="parameter">user_name ] > > [...] > > - [ IS_TEMPLATE [=] > class="parameter">istemplate ] ] > > + [ IS_TEMPLATE [=] > class="parameter">istemplate ] > > > > > > 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
Re: Trivial doc patch
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 name > -[ [ WITH ] [ OWNER [=] class="parameter">user_name ] > +[ WITH ] [ OWNER [=] class="parameter">user_name ] > [...] > - [ IS_TEMPLATE [=] class="parameter">istemplate ] ] > + [ IS_TEMPLATE [=] class="parameter">istemplate ] > > 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 signature.asc Description: PGP signature
Trivial doc patch
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. Rob >From dc59127d1a739e6de0cff20086baf47d15837f0b Mon Sep 17 00:00:00 2001 From: rir Date: Fri, 15 Oct 2021 11:29:26 -0400 Subject: [PATCH] Remove the only [optional] in synopses with [only optionals in it]. --- doc/src/sgml/ref/create_database.sgml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/sgml/ref/create_database.sgml b/doc/src/sgml/ref/create_database.sgml index 41cb4068ec..ec831bb57f 100644 --- a/doc/src/sgml/ref/create_database.sgml +++ b/doc/src/sgml/ref/create_database.sgml @@ -22,7 +22,7 @@ PostgreSQL documentation CREATE DATABASE name -[ [ WITH ] [ OWNER [=] user_name ] +[ WITH ] [ OWNER [=] user_name ] [ TEMPLATE [=] template ] [ ENCODING [=] encoding ] [ LOCALE [=] locale ] @@ -31,7 +31,7 @@ CREATE DATABASE name [ TABLESPACE [=] tablespace_name ] [ ALLOW_CONNECTIONS [=] allowconn ] [ CONNECTION LIMIT [=] connlimit ] - [ IS_TEMPLATE [=] istemplate ] ] + [ IS_TEMPLATE [=] istemplate ] -- 2.20.1
