public inbox for [email protected]  

help / color / mirror / Atom feed

From: Tom Lane <[email protected]>
To: Bruce Momjian <[email protected]>
Cc: Alvaro Herrera <[email protected]>
Cc: Dave Stewart <[email protected]>
Cc: David G. Johnston <[email protected]>
Cc: Pg Docs <[email protected]>
Subject: Re: Conventions
Date: Wed, 26 Jan 2022 21:33:58 -0500
Message-ID: <[email protected]> (raw)
In-Reply-To: <YfHZ9Ecpiy/[email protected]>
References: <[email protected]>
	<[email protected]>
	<YfHZ9Ecpiy/[email protected]>

Bruce Momjian <[email protected]> writes:
> OK, updated patch attached.  I don't think we even show TCL syntax
> anywhere anymore, so I removed that text, rather than moving it.

I really don't care for this phrasing at all:

-     the body of a PL/Tcl function:
+     the body of a PL/Tcl function (brackets (<literal>[</literal> and
+     <literal>]</literal>) are represented here as question marks):

It's unclear whether you mean actual brackets or metasyntactic brackets;
somebody who hasn't completely internalized the notion of brackets as
indicating optional elements would be particularly likely to
misunderstand.

I'd also suggest that wedging this into a parenthetic remark between a
sentence and the example the sentence is talking about is awkward.

I'd suggest a separate para at some point before the first usage,
along the lines of

   In this section, we follow the usual Tcl convention of using question
   marks, rather than brackets, to indicate an optional element in a
   syntax synopsis.

			regards, tom lane

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: [email protected]
  Cc: [email protected], [email protected], [email protected], [email protected], [email protected], [email protected]
  Subject: Re: Conventions
  In-Reply-To: <[email protected]>

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

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