Date: Fri, 20 Dec 2019 15:56:22 -0500
From: Bruce Momjian <bruce@momjian.us>
To: peter.m.gram@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: Make default values bold in Synopsis / bnf diagram
Message-ID: <20191220205622.GG29807@momjian.us>
References: <157532157256.21496.16702798757154104275@wrigleys.postgresql.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <157532157256.21496.16702798757154104275@wrigleys.postgresql.org>
User-Agent: Mutt/1.10.1 (2018-07-13)
Precedence: bulk

On Mon, Dec  2, 2019 at 09:19:32PM +0000, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/12/sql-set-transaction.html
> Description:
> 
> As an example let's take take "BEGIN"
> in the Synopsis : 
> -------- Start Synopsis for BEGIN --------------------
> BEGIN [ WORK | TRANSACTION ] [ transaction_mode [, ...] ]
> 
> where transaction_mode is one of:
> 
>     ISOLATION LEVEL { SERIALIZABLE | REPEATABLE READ | READ COMMITTED | READ
> UNCOMMITTED }
>     READ WRITE | READ ONLY
>     [ NOT ] DEFERRABLE
> -------- End Synopsis for BEGIN --------------------
> In this example the words to words "READ COMMITTED", "READ WRITE" should be
> bold since they are default values if I execute the statement "BEGIN;" see
> the example.

Uh, I don't think we bold the defaults in the syntax, but if we wanted
to do that, we should do it everywhere.  Is that something we want?  I
am afraid it would just make the default values stand out, which seems
counter-productive.

> By the way I started in "BEGIN" but here the defaults was not even present
> sow I went to "START TRANSACTION but still no indication on default values
> but finally in "SET TRANSACTION"
> There are default value for "ISOLATION LEVEL" but nothing on default value
> for "READ WRITE | READ ONLY" or  "[ NOT ] DEFERRABLE".

Uh, I see in the BEGIN manual page:

	If the isolation level, read/write mode, or deferrable mode is
	specified, the new transaction has those characteristics, as if SET
	TRANSACTION (SET_TRANSACTION(7)) was executed.

and in SET TRANSACTION:

	If the isolation level, read/write mode, or deferrable mode is
	specified, the new transaction has those characteristics, as if SET
	TRANSACTION (SET_TRANSACTION(7)) was executed.

Is "has those characteristics" unclear?

-- 
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +