docs

About docs of Clojure & libs
arrdem 2015-06-11T00:05:22.000037Z

https://github.com/clojure-grimoire/datastore/pull/5 Finally finished that big refactor of the Clojure examples...

arrdem 2015-06-11T00:06:23.000039Z

next on deck is finishing the flowing cheatsheet, and then ripping off the http://cljs.info style for individual documentation pages 😛

danielcompton 2015-06-11T01:35:36.000040Z

Reformat for style Reformat for style Reformat for style Reformat for style Reformat for style Reformat for style Reformat for style Reformat for style Reformat for style …. Reformat for style

arrdem 2015-06-11T01:37:45.000041Z

yep

arrdem 2015-06-11T01:37:50.000042Z

911 commits of style fixes

arrdem 2015-06-11T01:38:00.000043Z

and a couple duplicate/bad examples that got deleted

danielcompton 2015-06-11T02:01:16.000044Z

I find it really frustrating that most Clojure libraries assume that docstrings are appropriate documentation

arrdem 2015-06-11T15:49:45.000049Z

No they really aren't

aaronm 2015-06-11T15:58:45.000050Z

appropriate but not sufficient

arrdem 2015-06-11T17:44:30.000052Z

Yeah.

arrdem 2015-06-11T17:44:45.000053Z

The really hard part is writing and publishing discoverable usage examples...

arrdem 2015-06-11T17:45:04.000054Z

I really like what the Python docs do in that you have long format article/API documentation with small inline examples

arrdem 2015-06-11T17:45:17.000055Z

and working common case programs at the bottom