db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart (JIRA)" <derby-...@db.apache.org>
Subject [jira] Created: (DERBY-1920) DOCS - Improve topic titles for vague and duplicate topics
Date Tue, 03 Oct 2006 19:04:21 GMT
DOCS - Improve topic titles for vague and duplicate topics
----------------------------------------------------------

                 Key: DERBY-1920
                 URL: http://issues.apache.org/jira/browse/DERBY-1920
             Project: Derby
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 10.2.1.6
            Reporter: Laura Stewart
             Fix For: 10.2.2.0, 10.3.0.0


1) Many of the topic titles are vague. 
Examples - 
a) Almost all of the titles for the built-in function topics do not indicate that the topic
is about a "function".
The word "function" should be added to all of the reference topics (In the Reference Manual)
that discuss the built in functions
b) Almost all of the titles for the data type topics do not indicate that the topic is about
a data type.
The words "data type" should be added to all of the reference topics (In the Reference Manual)
that discuss the data types
c) Some of the SQL statement topic titles do not include the word "statement" in the title
and they should.

2)Some of the topics use the same title, but discuss very different things.  Each topic title
in the Derby documentation should be
unique.  
Examples - 
LOCK TABLE statement in the Reference Manual (http://db.apache.org/derby/docs/dev/ref/rrefsqlj40506.html)
and in the Tuning Guide (http://db.apache.org/derby/docs/dev/tuning/ctunoptimz11775.html)

This is just one of several examples.

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