mirrors
/
postgres
mirror of https://github.com/postgres/postgres
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify syntax notation, particularly parentheses 

Also move TCL syntax to the PL/tcl section.

Reported-by: davs2rt@gmail.com

Discussion: https://postgr.es/m/164308146320.12460.3590769444508751574@wrigleys.postgresql.org

Backpatch-through: 10
This commit is contained in:
Bruce Momjian 2022-02-02 21:53:52 -05:00
parent f3feff8259
commit 9d179d9c23
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/src/sgml/notation.sgml
View File

@ -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>

6
doc/src/sgml/pltcl.sgml
View File

@ -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>