It could also be be helpful to have links to mailing list discussions
or blog postings discussing the reasons for including a method in
Clojure or the tradeoffs in using one method vs. another. A few
examples:
seq?, sequential?
http://groups.google.com/group/clojure/browse_thread/thread/9dbaff59e
On 3 July 2010 10:12, David Nolen wrote:
> On Fri, Jul 2, 2010 at 3:46 AM, Justin Kramer wrote:
>>
>> Partly in response to this issue and partly to get my feet wet with
>> Ring and friends, I spent the last few nights writing a proof-of-
>> concept Wiki to collect structured Clojure usage exampl
On Fri, Jul 2, 2010 at 3:46 AM, Justin Kramer wrote:
> Partly in response to this issue and partly to get my feet wet with
> Ring and friends, I spent the last few nights writing a proof-of-
> concept Wiki to collect structured Clojure usage examples:
>
> http://clojure-examples.appspot.com/
>
>
Good suggestion about the categories. Making it browsable is
important. A page that uses categories from the cheatsheet is easy to
make. Adding categories/tags and auto-generating such a page is also
doable.
Code contributions are welcome. I'm not attached to App Engine; I just
used it to learn ab
Hey Justin!
Nice one! I'm actually planning on doing a similar thing, but hosting it on
Amazon's EC2.
Would you be interested in combining efforts together?
Cheers,
Greg Slepak
On Jul 2, 2010, at 3:46 AM, Justin Kramer wrote:
> Partly in response to this issue and partly to get my feet wet wi
+1
I like it, Justin. I was looking at making something myself but your
efforts are farther along. I'd be happy to help with any aspect of
this.
Ryan
On Fri, Jul 2, 2010 at 2:46 AM, Justin Kramer wrote:
> Partly in response to this issue and partly to get my feet wet with
> Ring and friends,
I'm very new here but I have to say I really like this. These kind of usage
examples are the most helpful resource for newcomers. I'll be happy to
contribute once I learn more.
Bob
On Jul 2, 2010, at 16:46, Justin Kramer wrote:
> Partly in response to this issue and partly to get my feet wet
On 2 Lip, 09:46, Justin Kramer wrote:
> Partly in response to this issue and partly to get my feet wet with
> Ring and friends, I spent the last few nights writing a proof-of-
> concept Wiki to collect structured Clojure usage examples:
>
> http://clojure-examples.appspot.com/
>
> Here's a sample
Partly in response to this issue and partly to get my feet wet with
Ring and friends, I spent the last few nights writing a proof-of-
concept Wiki to collect structured Clojure usage examples:
http://clojure-examples.appspot.com/
Here's a sample function page:
http://clojure-examples.appspot.com
Mark Fredrickson wrote:
Hello Tim,
Knuth originally created an idea of literate programming
where you embed source code into latex documents. He called
such documents "web" documents (because nobody had yet used
the word "web").
Thanks for passing along your code. I have some famili
Hello Tim,
> Knuth originally created an idea of literate programming
> where you embed source code into latex documents. He called
> such documents "web" documents (because nobody had yet used
> the word "web").
Thanks for passing along your code. I have some familiarity with
noweb. I use Sweave
Mark,
Knuth originally created an idea of literate programming
where you embed source code into latex documents. He called
such documents "web" documents (because nobody had yet used
the word "web").
tangle doc.web ==> executable source code
weave doc.web ==> latex document
Knuth's web assumes
> It's a great start. However, examples are much more useful if you know
> what they should produce. run-examples might provide that, but having
> them in the metadata would be even better - along with an explanation.
>From my original email:
=== Examples ===
> (foo 1 2)
3
> (foo 3 4)
7
B
On Tue, 29 Jun 2010 17:01:10 -0700 (PDT)
Mark Fredrickson wrote:
> On Jun 29, 5:43 pm, nickikt wrote:
> > We could make it possible to add some metadata to a function
> > like :example or something. Then add a function called (example
> > ) to print the example.
> >
> > Everybody could send patch
On 30 June 2010 10:01, Mark Fredrickson wrote:
> user> (doc foo)
> -
> user/foo
> ([a b])
> Adds two numbers
> === Categories ===
>
> :bar, :baz, :other
>
> === See Also ===
>
> * #'user/bar
>
> === Examples ===
>
>> (foo 1 2)
> 3
>> (foo 3 4)
> 7
>
> === References ===
>
On Jun 29, 5:43 pm, nickikt wrote:
> We could make it possible to add some metadata to a function
> like :example or something. Then add a function called (example
> ) to print the example.
>
> Everybody could send patches. It would be a good way to learn and a
> good extra doku.
I was consider
On 29 June 2010 09:13, Tom Faulhaber wrote:
> However, speaking for myself only, I don't think that the doc strings
> are the place for a comprehensive set of examples.
Seconded.
On 29 June 2010 12:33, Heinz N. Gies wrote:
> There is Walton that covers that. Talk to defn in #clojure if you want
We could make it possible to add some metadata to a function
like :example or something. Then add a function called (example
) 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 wrote:
> I don't know about t
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 c
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:
Hi people!
I love PHP documentation
http://www.php.net/manual/en/
and its function reference:
http://www.php.net/manual/en/funcref.php
Each function has a dedicated page, with detailed description, initial
examples. And visitors can add new examples or limit cases. Example:
http://www.php.net/
I would LOVE to have simple examples for all functions, anyplace that makes
them easy to access during coding. In docstrings would be fine with me, but
other places would work as well.
Here again the Processing project (among others, I'm sure) provides a nice
example IMHO, even though Processi
There is Walton that covers that. Talk to defn in #clojure if you want to know
detail
Regards,
Heinz
Sent from my iPad
On Jun 29, 2010, at 6:06 AM, cageface wrote:
> Several people have suggested that usage examples in the docs would be
> helpful and this is something I often find myself wish
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,
24 matches
Mail list logo
