On Mon, May 13, 2013 at 3:01 PM, Gary Deer <gdee...@gmail.com> wrote:
> What are your plans for documentation beyond the doc strings?

There are some additional documentation pages, based on the doc folder
in the Github repo here:
https://github.com/clojure/java.jdbc/tree/master/doc/clojure/java/jdbc

http://clojure.github.io/java.jdbc/doc/clojure/java/jdbc/UsingSQL.html
http://clojure.github.io/java.jdbc/doc/clojure/java/jdbc/UsingDDL.html
http://clojure.github.io/java.jdbc/doc/clojure/java/jdbc/NameMapping.html
http://clojure.github.io/java.jdbc/doc/clojure/java/jdbc/ConnectionPooling.html

I'm open to suggestions :)

I think in-depth documentation for using java.jdbc probably belongs
somewhere like http://clojure-doc.org - (but I'm not quite sure where
it belongs on that site) - i.e., separate from the core/contrib
reference documentation.

> I've been
> trying to keep track of how I'm using the library and documenting my own use
> cases as much as possible.  I've also dusted off some old database
> programming books to convert some basic java examples to Clojure.  I wish I
> could help out with the effort more, but I'm not as intimate with the code
> base, so at best I can document simple things and at worst document bad
> examples.

http://clojure-doc.org is easy to contribute to so with a bit of
guidance from that team, perhaps we can start a section there for
java.jdbc documentation? And maybe move the four pieces of
documentation above from the contrib repo to the clojure-doc repo?
--
Sean A Corfield -- (904) 302-SEAN
An Architect's View -- http://corfield.org/
World Singles, LLC. -- http://worldsingles.com/

"Perfection is the enemy of the good."
-- Gustave Flaubert, French realist novelist (1821-1880)

-- 
-- 
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
--- 
You received this message because you are subscribed to the Google Groups 
"Clojure" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to clojure+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to