Kim Haase created DERBY-6345:
--------------------------------
Summary: Correct Getting Started syntax topic and include it in
Reference Manual
Key: DERBY-6345
URL: https://issues.apache.org/jira/browse/DERBY-6345
Project: Derby
Issue Type: Bug
Components: Documentation
Affects Versions: 10.10.1.1
Reporter: Kim Haase
Assignee: Kim Haase
Priority: Minor
The "SQL syntax" topic of the Getting Started guide has a misleading
description of the meaning of curly braces: "Groups items so that they can be
marked with one of the symbols [ ], |, or *."
In the manuals, the actual usage is to group required items so that they can be
marked with "|" (to indicate a choice of one of several items). The description
should be fixed.
Also, the syntax conventions are not solely for SQL. In the Getting Started
manual, the conventions are also used for commands such as sysinfo. So perhaps
the title should be changed there to something more general.
In addition, since syntax is used primarily in the Reference Manual, the "SQL
syntax" topic should also be placed in that manual, probably in the "About this
guide" section at the beginning. Here the title is appropriate, since the
syntax conventions seem to be used only in SQL syntax.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
