db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ramandeep Kaur (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-382) Doc Review: Derby Reference Manual
Date Mon, 27 Jun 2005 22:11:58 GMT
    [ http://issues.apache.org/jira/browse/DERBY-382?page=comments#action_12314555 ] 

Ramandeep Kaur commented on DERBY-382:
--------------------------------------

I reviewed Derby Reference Manual -->Derby Limitations section and following are some of
the comments/suggestions.

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. Right above each table of this section, the line "The following table contains limitations
...................................." might be
    "The following table lists limitations ......................".

4. In subsection "Limitations for Database Manager values", some of the rows in first column
has most in it. For example: "Most columns in a table". Should it be "Maximum columns in a
table"

Thanks, Raman

> Doc Review: Derby Reference Manual
> ----------------------------------
>
>          Key: DERBY-382
>          URL: http://issues.apache.org/jira/browse/DERBY-382
>      Project: Derby
>         Type: Improvement
>   Components: Documentation
>  Environment: all
>     Reporter: Jeff Levitt
>     Priority: Minor
>      Fix For: 10.1.1.0

>
> This issue tracks comments for the Derby Reference Manual. The deadline for posting comments
is Tuesday, June 28, noon Pacific time.
> Some guidelines to follow when posting comments to this issue are:
> - Try to make clear and concise comments about what you want changed whenever possible.
 Provide concrete comments that say "Please change <original> to <modified>" instead
of generic comments like "This section needs to be rewritten."
> - If you're reviewing the HTML Files copy, include the URL for the page in the review
comment. Obtain the URL like this:
>     * highlight the topic in the left frame
>     * right click
>     * choose "Properties"
>     * copy and paste the address in the pop up box.
> - If you're reviewing the PDF copy, in the review comment:
>     * Include the page number for the PDF, and indicate whether the number is the PDF
sheet number or the printed page number.
>     * Include the title of the section that the problem occurs in. If it's in a subsection,
try to include the hierarchy of titles.
> - Please don't review the HTML Book copy -- it'll be time consuming to match up that
copy with the underlying DITA source.

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


Mime
View raw message