Re: (doc more-examples)

2011-07-17 Thread Resty Cena
Or an option for more extended doc when launching REPL for those who need
the extra documentation more than performance during development, or maybe a
searchable dictionary panel at the left hand side of REPL, ala some versions
of Ruby's irb.

Meanwhile, thanks for the pointer to the clojure quickref at clojuredocs.org.
Good enough.

Tuba

On Sat, Jul 16, 2011 at 9:11 PM, Stuart Halloway
stuart.hallo...@gmail.comwrote:

 On Sat, Jul 16, 2011 at 2:23 AM, Tuba Lambanog tuba.lamba...@gmail.com
 wrote:

 More examples in how to use a form in the (doc ...) facility within

 REPL would be very useful to newbies. Thanks.


 That would mean the docstrings need to provide more detail in the
 source code. Not sure how practical that is since the docstrings would
 substantially outweigh the code - maybe Clojure/core could comment?


 I wouldn't use docstrings for this, as they increase runtime footprint.

 That said, an alternate doc macro could look other places besides
 docstrings. It shouldn't be difficult to write an examples macro that calls
 out to e.g. clojuredocs.org.

 Stu


 Stuart Halloway
 Clojure/core
 http://clojure.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


-- 
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

(doc more-examples)

2011-07-16 Thread Tuba Lambanog
Hello,
More examples in how to use a form in the (doc ...) facility within
REPL would be very useful to newbies. Thanks.
tuba

-- 
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


Re: (doc more-examples)

2011-07-16 Thread Sean Corfield
On Sat, Jul 16, 2011 at 2:23 AM, Tuba Lambanog tuba.lamba...@gmail.com wrote:
 More examples in how to use a form in the (doc ...) facility within
 REPL would be very useful to newbies. Thanks.

That would mean the docstrings need to provide more detail in the
source code. Not sure how practical that is since the docstrings would
substantially outweigh the code - maybe Clojure/core could comment?

I'd recommend using the community-managed clojuredocs.org website
since anyone can login and add / edit examples and notes etc.

Not as convenient from the REPL, I agree, but I find I always have
clojuredocs.org and clojureatlas.com open in tabs in my browser when I
need more detail.
-- 
Sean A Corfield -- (904) 302-SEAN
An Architect's View -- http://corfield.org/
World Singles, LLC. -- http://worldsingles.com/
Railo Technologies, Inc. -- http://www.getrailo.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


Re: (doc more-examples)

2011-07-16 Thread Stuart Halloway
 On Sat, Jul 16, 2011 at 2:23 AM, Tuba Lambanog tuba.lamba...@gmail.com 
 wrote:
 More examples in how to use a form in the (doc ...) facility within
 REPL would be very useful to newbies. Thanks.
 
 That would mean the docstrings need to provide more detail in the
 source code. Not sure how practical that is since the docstrings would
 substantially outweigh the code - maybe Clojure/core could comment?

I wouldn't use docstrings for this, as they increase runtime footprint.

That said, an alternate doc macro could look other places besides docstrings. 
It shouldn't be difficult to write an examples macro that calls out to e.g. 
clojuredocs.org.

Stu


Stuart Halloway
Clojure/core
http://clojure.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