I like the idea of having example code for all the functions. However, speaking for myself only, I don't think that the doc strings are the place for a comprehensive set of examples.
How about building them in some external place? (Maybe as a separate github project to begin with.) In particular, it would be nice if the examples used some literate programming technique that let users open the examples and play with them. That way, they could be linked to from the documentation (I could roll it into autodoc, for instance, subject to Rich and Stuart's constraints) but also directly opened, tried, copied, etc. from your editor and repl. It's easy for me to imagine that, in the not too distant future, we could roll that into Clojure core in a way similar to the tests. Tom On Jun 28, 9:06 pm, cageface <milese...@gmail.com> wrote: > Several people have suggested that usage examples in the docs would be > helpful and this is something I often find myself wishing for. Are > patches introducing examples welcomed by the core team? -- 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
