[ https://issues.apache.org/jira/browse/DERBY-1920?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12478479 ]
Laura Stewart commented on DERBY-1920: -------------------------------------- The 5th Ref Guide patch looks good. I was a little surprised that Concatenation is a operator rather than a function... :-) > 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-ref4.diff, > DERBY-1920-ref4.zip, DERBY-1920-ref5.diff, DERBY-1920-ref5.zip, > DERBY-1920-ref6.diff, DERBY-1920-ref6.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.