diff options
author | Bruce Momjian | 2022-02-03 02:53:52 +0000 |
---|---|---|
committer | Bruce Momjian | 2022-02-03 02:53:52 +0000 |
commit | 9d179d9c23b9d4cc1a4ffa02e4de79114de064d7 (patch) | |
tree | eca0dd10f3881331c1045828052ac488fa104d10 | |
parent | f3feff825940972c0dcf1173f0a6a4ff43f8d382 (diff) |
doc: clarify syntax notation, particularly parentheses
Also move TCL syntax to the PL/tcl section.
Reported-by: [email protected]
Discussion: https://postgr.es/m/[email protected]
Backpatch-through: 10
-rw-r--r-- | doc/src/sgml/notation.sgml | 6 | ||||
-rw-r--r-- | doc/src/sgml/pltcl.sgml | 6 |
2 files changed, 7 insertions, 5 deletions
diff --git a/doc/src/sgml/notation.sgml b/doc/src/sgml/notation.sgml index bd1e8f629a..c3798d5f1b 100644 --- a/doc/src/sgml/notation.sgml +++ b/doc/src/sgml/notation.sgml @@ -6,12 +6,12 @@ <para> The following conventions are used in the synopsis of a command: brackets (<literal>[</literal> and <literal>]</literal>) indicate - optional parts. (In the synopsis of a Tcl command, question marks - (<literal>?</literal>) are used instead, as is usual in Tcl.) Braces + optional parts. Braces (<literal>{</literal> and <literal>}</literal>) and vertical lines (<literal>|</literal>) indicate that you must choose one alternative. Dots (<literal>...</literal>) mean that the preceding element - can be repeated. + can be repeated. All other symbols, including parentheses, should be + taken literally. </para> <para> diff --git a/doc/src/sgml/pltcl.sgml b/doc/src/sgml/pltcl.sgml index 1759fc4498..9839e375ad 100644 --- a/doc/src/sgml/pltcl.sgml +++ b/doc/src/sgml/pltcl.sgml @@ -320,8 +320,10 @@ $$ LANGUAGE pltcl; <title>Database Access from PL/Tcl</title> <para> - The following commands are available to access the database from - the body of a PL/Tcl function: + 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. The following commands are available to access + the database from the body of a PL/Tcl function: <variablelist> |