This is a discussion on Re: Documentation for jdbc escapes within the pgsql Interfaces jdbc forums, part of the PostgreSQL category; --> On Fri, 21 Jan 2005, Xavier Poinsard wrote: > I just wrote my first piece of docbook to document ...
| |||||||
| FAQ | Members List | Calendar | Search | Today's Posts | Mark Forums Read |
| ||||
| On Fri, 21 Jan 2005, Xavier Poinsard wrote: > I just wrote my first piece of docbook to document the jdbc escaped > functions supported by the driver. Don't hesitate to comment. I didn't > write about the procedure calls since I don't know the current state of > the driver for this part. I hope this could be included in the driver > documentation. If you are soliciting general comments it would help to make it available in a more accessible format: http://www.ejurka.com/pgsql/docs/escfunc/ For general feedback it seems a little too table oriented with not enough accompanying text. Describing what the argument reordering and duplicate problem actually is would be helpful. Also an example including Java code would help the understanding process of how to actually call these functions. Mentioning Connection.nativeSQL() seems appropriate. In terms of specific feedback: - it should mention outer join escapes - the translation of dayname is in the wrong column (Table 1.3) - The comments should be full sentences, starting with a capital letter ending with a period. - Section titles should get some captialization. - Provide html link to referenced JDBC Technology guide - A number of typos/grammatical errors: - First paragraph - of of - had to specify way -> had to speciy a way - Second section (escaped scalar functions) - tables are showing -> tables show - The driver support -> The driver supports - specification describe the -> specification describes the Kris Jurka ---------------------------(end of broadcast)--------------------------- TIP 1: subscribe and unsubscribe commands go to majordomo@postgresql.org |
| ||||
| On Tue, 25 Jan 2005, Xavier Poinsard wrote: > I updated the my documentation attempt with your remarks and added > mention for escape char escape. > Applied. Kris Jurka ---------------------------(end of broadcast)--------------------------- TIP 2: you can get off all lists at once with the unregister command (send "unregister YourEmailAddressHere" to majordomo@postgresql.org) |