db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dag H. Wanvik (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-1997) Misleading text in WwdEmbedded demo source file for Working With Derby
Date Mon, 24 Jun 2013 05:37:20 GMT

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

Dag H. Wanvik commented on DERBY-1997:
--------------------------------------

The last patch (by date) looks good to me +1. 

Hint: We usually use the .diff suffix,and intelligible names on the patch its self, e.g. derby-<issue>[-<partid>]-<rev>.diff.
The <partid> is often omitted for simple issues, being called into service only for
issues for which many incremental patches are needed.  That said, exact usage varies among
devs ;-)

This makes it easier for reviewers that download many patches to keep track of them. 
                
> Misleading text in WwdEmbedded demo source file for Working With Derby
> ----------------------------------------------------------------------
>
>                 Key: DERBY-1997
>                 URL: https://issues.apache.org/jira/browse/DERBY-1997
>             Project: Derby
>          Issue Type: Bug
>          Components: Demos/Scripts, Documentation
>    Affects Versions: 10.2.1.6
>            Reporter: Kim Haase
>            Priority: Minor
>              Labels: derby_triage10_5_2
>         Attachments: vcs-diff3523819486798216332.patch, vcs-diff7276709987551559550.patch
>
>
> I'm making some minor fixes to the Working With Derby manual (DERBY-1948, DERBY-1972).
The description of the WwdEmbedded.java program in the HTML generated from the file rwwdactivity3.dita
(http://db.apache.org/derby/docs/dev/workingwithderby/) contains the following paragraph:
> DERBY EXCEPTION REPORTING CLASSES: The two methods at the end of the file, errorPrint
and SQLExceptionPrint, are generic exception reporting routines that can be used with any
JDBC program. This type of exception handling is required because often multiple exceptions
(SQLException) are chained together then thrown. A while loop is used to report on each error
in the chain. These classes are used by calling the errorPrint method from the catch block
of the code that accesses the database.
> The introductory text "DERBY EXCEPTION REPORTING CLASSES" is keyed to a comment with
the same text in the DERBY_HOME/demo/programs/workingwithderby/WwdEmbedded.java program:
>      //   ## DERBY EXCEPTION REPORTING CLASSES  ## 
>     /***     Exception reporting methods
>     **      with special handling of SQLExceptions
>     ***/
> The problem is that there are no Derby exception reporting classes, only methods, as
far as I can tell. The use of the term CLASSES is likely to confuse any users not well acquainted
with Java (one of the target audiences of this manual). It would be great if someone could
change CLASSES to METHODS in the WwdEmbedded.java file so that I can make the corresponding
fix to the rwwdactivity3.dita file. I would also have to correct the confusing last sentence
of the paragraph; I think it would make more sense to say, "The program starts this process
by calling the errorPrint method from the catch block of the code that accesses the database."
(I can't just change "classes" to "methods" because errorPrint *is* one of the methods.

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

Mime
View raw message