Skip to content

Commit 9d179d9

Browse files
committed
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
1 parent f3feff8 commit 9d179d9

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

doc/src/sgml/notation.sgml

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66
<para>
77
The following conventions are used in the synopsis of a command:
88
brackets (<literal>[</literal> and <literal>]</literal>) indicate
9-
optional parts. (In the synopsis of a Tcl command, question marks
10-
(<literal>?</literal>) are used instead, as is usual in Tcl.) Braces
9+
optional parts. Braces
1110
(<literal>{</literal> and <literal>}</literal>) and vertical lines
1211
(<literal>|</literal>) indicate that you must choose one
1312
alternative. Dots (<literal>...</literal>) mean that the preceding element
14-
can be repeated.
13+
can be repeated. All other symbols, including parentheses, should be
14+
taken literally.
1515
</para>
1616

1717
<para>

doc/src/sgml/pltcl.sgml

+4-2
Original file line numberDiff line numberDiff line change
@@ -320,8 +320,10 @@ $$ LANGUAGE pltcl;
320320
<title>Database Access from PL/Tcl</title>
321321

322322
<para>
323-
The following commands are available to access the database from
324-
the body of a PL/Tcl function:
323+
In this section, we follow the usual Tcl convention of using question
324+
marks, rather than brackets, to indicate an optional element in a
325+
syntax synopsis. The following commands are available to access
326+
the database from the body of a PL/Tcl function:
325327

326328
<variablelist>
327329

0 commit comments

Comments
 (0)