We could make it possible to add some metadata to a function like :example or something. Then add a function called (example <function name>) to print the example.
Everybody could send patches. It would be a good way to learn and a good extra doku. On Jun 30, 12:29 am, Lee Spector <lspec...@hampshire.edu> wrote: > I don't know about the accuracy either but I think this is great in terms of > coverage and organization. > > BTW "cons" is from Lisp, short for "construct". > > -Lee > > On Jun 29, 2010, at 5:16 PM, Ryan Waters wrote: > > > > > I've wanted to work on expanded documentation for Clojure, too, both > > as a way to contribute something I think is needed and as a way to > > learn Clojure. To illustrate what I have in mind, I put together an > > example of new documentation for 'conj' located here (a read-only > > google doc, for now): > > >http://bit.ly/9YOvgP > > > Try to imagine the information tastefully laid out with a lot of > > hyperlinking, category cross-referencing and additional organization à > > la the Clojure Cheat Sheet. Not only would it be a way to see example > > code, both toy examples and real-world examples, but also a way to tie > > together related functions/macros, explanations and/or outside linking > > for some of the larger concepts (like clojure.org sidebar topics, > > links to relevant videos, books?, etc.) > > > The target audience I had in mind would be people who want to learn > > clojure and want to have an available reference more expository than > > the current API docs. > > > Please note that I'm still learning Clojure and one or more bits of > > information at the above link may be incorrect! And it's still very > > unfinished; I know at least one of the terms used is incorrect > > ("items"? I whipped it together ...). I would welcome corrections and > > explanations, even if what I've produced so far is just a simple > > example of what could be. > > > - Ryan Waters > > -- > Lee Spector, Professor of Computer Science > School of Cognitive Science, Hampshire College > 893 West Street, Amherst, MA 01002-3359 > lspec...@hampshire.edu,http://hampshire.edu/lspector/ > Phone: 413-559-5352, Fax: 413-559-5438 > > Check out Genetic Programming and Evolvable > Machines:http://www.springer.com/10710-http://gpemjournal.blogspot.com/ -- 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
