db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Knut Anders Hatlen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-6353) Update syntax description in Getting Started, use in Reference Manual too
Date Tue, 01 Oct 2013 14:14:24 GMT

    [ https://issues.apache.org/jira/browse/DERBY-6353?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13782961#comment-13782961
] 

Knut Anders Hatlen commented on DERBY-6353:
-------------------------------------------

Looks good to me.

One tiny nit: The patch removes a blank between the square bracket and the asterisk in the
example in the getting started guide, whereas the copy in the new reference manual topic preserves
the blank. It looks like DERBY-6121 made the reference manual use the style with no blank
consistently (except in the CREATE TABLE statement topic), so we should probably make the
example follow the same style.

> Update syntax description in Getting Started, use in Reference Manual too
> -------------------------------------------------------------------------
>
>                 Key: DERBY-6353
>                 URL: https://issues.apache.org/jira/browse/DERBY-6353
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.10.1.1
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: DERBY-6353.diff, DERBY-6353.stat, DERBY-6353.zip
>
>
> The "SQL Syntax" topic in the Getting Started guide (http://db.apache.org/derby/docs/10.10/getstart/rgsdocs10012.html)
does not describe the curly braces ("{ }") as they are actually used in syntax statements,
where they actually group required items, normally so choices can be separated by vertical
bars ("|"). This should be corrected.
> I also plan to adopt the suggestion made in DERBY-6121 that the topic be added to the
Reference Manual, where syntax is most used. 
> Does anything else in the topic need fixing? I am confused by the statement that the
asterisk "has a special meaning in some SQL statements." What special meaning can it have
other than marking repeatable items?



--
This message was sent by Atlassian JIRA
(v6.1#6144)

Mime
View raw message