Issues for Derby Ref manual
---------------------------
Key: DERBY-423
URL: http://issues.apache.org/jira/browse/DERBY-423
Project: Derby
Type: Task
Components: Documentation
Environment: all
Reporter: Jeff Levitt
Priority: Minor
Fix For: 10.2.0.0
The Reference Manual was reviewed for Version 10.1, and some of the comments in
that review (http://issues.apache.org/jira/browse/DERBY-382) were not
incorporated dude to their complexity. I am listing them here to track them
for 10.2.
Generic issues:
1. All the tables in this section has number "1" only. Each table should have
its own number.
2. At the footer of document, might need to add Manual name and main section
name so that it is easier to see which guide and a section a particular page
belongs to.
3. Derby Limitations section starts at page 224 of the document, but table of
content lists it starting at page 223.
4. In first paragraph of this section, a space should be removed from in
between "identifies" and "." in line "See Rules for SQL92 identifiers". (This
happens with links for some reason in the PDF)
The aggregates section has been mixed in with the functions section. They
should be seprate. So, there should be a section called Built-in funtions with
the list that is on page 72 and 73, followed by all of the writeups on each
function. Then, you should have a separate section called aggregates with the
overview on that, followed by the individual writeups on each aggregate.
The table on page 73 has characters in cells that should be blank.
Page 74: Move AVG writeup to aggregate section
Page 81: Move COUNT writeup to aggregate section
Page 82: Move COUNT(*) writeup to aggregate section.
Page 90: Move MAX writeup to aggregate section.
Page 91: Move MIN writeup to aggregate section.
Page 95: Move SUM writeup to aggregate section.
Page 99: Change the paragraph under Buil-In system procedures to something like
the following:
Some built-in procedures are not compatible with standard SQL syntax use by
other relational databases. These procedures can only be used with Derby.
"In the new section on error messages, I believe all mentions of severity
should be removed. This is a derby specific implementation detail and is not
standard based. The SQLException.getErrorCode() is intentionally specific to
each vendor. Derby should not be encouraging applications to use this method to
affect application flow. Application's making decisions based upon
SQLExceptions is being addressed in JDBC 4.0.
Maybe the third column of the table could be the effect on the transaction and
not a numerical code." (The first half has been done (severity removed), but
the seconf half will need input and quite a bit of replacing to do)
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
