Re: [racket] Learning Scribble

2013-12-13 Thread Ryan Davis
On Nov 23, 2013, at 8:21, Matthias Felleisen wrote: > > On Nov 23, 2013, at 10:45 AM, Laurent wrote: > >> On Sat, Nov 23, 2013 at 4:04 PM, Greg Hendershott >> wrote: >> >> Let me see if I can find time to review the current docs for Planet >> and the new package system, and see where more

Re: [racket] Learning Scribble

2013-11-25 Thread John Clements
On Nov 23, 2013, at 8:21 AM, Matthias Felleisen wrote: > > On Nov 23, 2013, at 10:45 AM, Laurent wrote: > >> On Sat, Nov 23, 2013 at 4:04 PM, Greg Hendershott >> wrote: >> >> Let me see if I can find time to review the current docs for Planet >> and the new package system, and see where mor

Re: [racket] Learning Scribble

2013-11-25 Thread Eli Barzilay
On Friday, Sam Tobin-Hochstadt wrote: > On Fri, Nov 22, 2013 at 8:46 AM, Eli Barzilay wrote: > > > > It's probably good to make this an important goal when learning > > the system, even though it's a small corner of the whole thing > > now... > > I think Eli means "the documentation system" by "t

Re: [racket] Learning Scribble

2013-11-24 Thread Greg Hendershott
Does the Scribble doc preap part of McFly work independently of the Planet package part? What I mean is, can McFly be used to prepare Scribble docs for packages for the new package system? Racket Users list: http://lists.racket-lang.org/users

Re: [racket] Learning Scribble

2013-11-23 Thread Neil Van Dyke
Laurent wrote at 11/23/2013 10:45 AM: I think what is missing is a complete example as a tutorial, like "You've written a module? Here is what to do, step by step, to document it and make it a package. Here is the example module file, here is the corresponding scribble file (with defproc, def

Re: [racket] Learning Scribble

2013-11-23 Thread Matthias Felleisen
On Nov 23, 2013, at 10:45 AM, Laurent wrote: > On Sat, Nov 23, 2013 at 4:04 PM, Greg Hendershott > wrote: > > Let me see if I can find time to review the current docs for Planet > and the new package system, and see where more examples/tips -- or at > least links to examples -- could go, and

Re: [racket] Learning Scribble

2013-11-23 Thread Laurent
On Sat, Nov 23, 2013 at 4:04 PM, Greg Hendershott wrote: > > Let me see if I can find time to review the current docs for Planet > and the new package system, and see where more examples/tips -- or at > least links to examples -- could go, and submit a PR. > My 2 cents: I think what is missing i

Re: [racket] Learning Scribble

2013-11-23 Thread Greg Hendershott
On Fri, Nov 22, 2013 at 6:41 PM, Sam Tobin-Hochstadt wrote: > On Fri, Nov 22, 2013 at 8:46 AM, Eli Barzilay wrote: >> >>> Later I finally grokked why. I can translate the at-exp to the s-exp >>> on the fly. >> >> It's probably good to make this an important goal when learning the >> system, even

Re: [racket] Learning Scribble

2013-11-22 Thread Sam Tobin-Hochstadt
On Fri, Nov 22, 2013 at 8:46 AM, Eli Barzilay wrote: > >> Later I finally grokked why. I can translate the at-exp to the s-exp >> on the fly. > > It's probably good to make this an important goal when learning the > system, even though it's a small corner of the whole thing now... I think Eli mea

Re: [racket] Learning Scribble

2013-11-22 Thread Eli Barzilay
Yesterday, Greg Hendershott wrote: > "Use {} with item but [] with itemize". > > @itemize[ > @item{x} > @item{y} > @item{z} > ] The point here is that {...} is intended for text, so if you use @itemize{} you end up with the text between the items too (the newlines in the above). IIRC, orig

Re: [racket] Learning Scribble

2013-11-21 Thread Greg Hendershott
I totally empathize, I had the same experience. Initially I found it completely baffling. The feeling: "Like parens? Here's three kinds! Good luck remembering when to use which. And be careful where you put spaces." That's unfair to the reference docs, which are perfectly clear as I read them tod

[racket] Learning Scribble

2013-11-21 Thread Josh McGrath
I've been learning Scribble so that I can document a small library. I think that some sort of users guide specifically for documenting libraries that *hides *details would be very useful. I found myself reading quite a bit of prose and only having a vague sense of how to do things. Now when I go ba