db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-1920) DOCS - Improve topic titles for vague and duplicate topics
Date Wed, 21 Feb 2007 22:49:05 GMT

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

Kim Haase commented on DERBY-1920:
----------------------------------

For the cdevstandards files, I was trying to be consistent with the other titles in that section:

    * ALTER TABLE
    * Calling functions and procedures
    * CLOB and BLOB
    * Cursors
    * DECIMAL max precision
    * Dynamic SQL
    * Expressions on LONGs
    * Information schema
    * NOT NULL characteristic
    * Transactions
    * Stored routines and PSM
    * Unique constraints and nulls
    * XML data types and operators

Also, in fact, this is a list of *non*standard features, so we'd have to make each title "Nonstandard
feature: xxx" or something like that.

Also, see what happens in the main "Derby and standards" topic with them as they are: they're
all pulled into that page, except for the long last topic. I've been puzzling over this. It's
really kind of silly to have all these different tiny topics when what you really do want
is just the bullet list in the "Derby and standards" topic. The only glitch is that really
long last topic. 

What do you think is the best solution here? 

> DOCS - Improve topic titles for vague and duplicate topics
> ----------------------------------------------------------
>
>                 Key: DERBY-1920
>                 URL: https://issues.apache.org/jira/browse/DERBY-1920
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.2.1.6
>            Reporter: Laura Stewart
>         Assigned To: Kim Haase
>             Fix For: 10.2.3.0, 10.3.0.0
>
>         Attachments: DERBY-1920-devguide.diff, DERBY-1920-devguide.zip, DERBY-1920-tuning.diff,
DERBY-1920-tuning.zip, DERBY-1920.list, DERBY-1920.list-2.txt, DERBY-1920.list-3.txt, DERBY-1920_list_ls.htm
>
>
> 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.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message