From derby-dev-return-37846-apmail-db-derby-dev-archive=db.apache.org@db.apache.org Fri Mar 02 21:01:29 2007 Return-Path: Delivered-To: apmail-db-derby-dev-archive@www.apache.org Received: (qmail 56841 invoked from network); 2 Mar 2007 21:01:27 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 2 Mar 2007 21:01:27 -0000 Received: (qmail 24483 invoked by uid 500); 2 Mar 2007 21:01:26 -0000 Delivered-To: apmail-db-derby-dev-archive@db.apache.org Received: (qmail 24444 invoked by uid 500); 2 Mar 2007 21:01:26 -0000 Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: Delivered-To: mailing list derby-dev@db.apache.org Received: (qmail 24406 invoked by uid 99); 2 Mar 2007 21:01:26 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 02 Mar 2007 13:01:26 -0800 X-ASF-Spam-Status: No, hits=0.0 required=10.0 tests= X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO brutus.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 02 Mar 2007 13:01:17 -0800 Received: from brutus (localhost [127.0.0.1]) by brutus.apache.org (Postfix) with ESMTP id 2041C7142FA for ; Fri, 2 Mar 2007 13:00:56 -0800 (PST) Message-ID: <22700146.1172869256129.JavaMail.jira@brutus> Date: Fri, 2 Mar 2007 13:00:56 -0800 (PST) From: "Laura Stewart (JIRA)" To: derby-dev@db.apache.org Subject: [jira] Commented: (DERBY-1920) DOCS - Improve topic titles for vague and duplicate topics In-Reply-To: <31595555.1159902261829.JavaMail.root@brutus> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-Virus-Checked: Checked by ClamAV on apache.org [ https://issues.apache.org/jira/browse/DERBY-1920?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12477445 ] Laura Stewart commented on DERBY-1920: -------------------------------------- The 3rd Ref Guide patch looks good and was committed. Committed revision 513945. > 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-adminguide.diff, DERBY-1920-adminguide.zip, DERBY-1920-devguide.diff, DERBY-1920-devguide.zip, DERBY-1920-ref1.diff, DERBY-1920-ref1.zip, DERBY-1920-ref2.diff, DERBY-1920-ref2.zip, DERBY-1920-ref3.diff, DERBY-1920-ref3.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.