diff options
| author | Bruce Momjian <bruce@momjian.us> | 2022-02-02 21:53:51 -0500 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2022-02-02 21:53:51 -0500 |
| commit | 25560761289e5dbe21514c9ef2cf7272d9181488 (patch) | |
| tree | 819c81ca477f7016b8d7a31b846895fb484e4175 | |
| parent | ee57467cb6b2ce1e25d367cbd64cc60ae9ba0eb3 (diff) | |
| download | postgresql-25560761289e5dbe21514c9ef2cf7272d9181488.tar.gz postgresql-25560761289e5dbe21514c9ef2cf7272d9181488.zip | |
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
| -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 bd1e8f629a6..c3798d5f1be 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 1759fc44985..9839e375ad3 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> |