[racket] comments on format for api documentation embedded in modules

2014-12-17 Thread Neil Van Dyke
Anyone have comments on how they'd like to embed API documentation within Racket module source code? I've done in two ways so far, and am about to write a new tool for this, so I have a chance to rethink it. The earlier two ways; * The first way I did it, for generic Scheme, was in Funcelit

Re: [racket] documentation format for racket packages

2014-12-17 Thread Matthew Flatt
At Wed, 17 Dec 2014 22:00:36 -0500, Neil Van Dyke wrote: > Two questions, for the documentation of a single-collection package in > `.zip` format (in the new package system)... > > * Given that the package is named `mypackage`, must the Scribble file be > named `mypackage.scrbl`, or will things

Re: [racket] raco command extension changed in 6.1?

2014-12-17 Thread Matthew Flatt
It wasn't supposed to change, but apparently something has broken between 6.0.1 and 6.1. Running `raco setup` afterward adds `raco mcfly`, but the `require` should have been enough, and I'll investigate further. At Wed, 17 Dec 2014 21:52:41 -0500, Neil Van Dyke wrote: > Did how `raco` commands ar

[racket] documentation format for racket packages

2014-12-17 Thread Neil Van Dyke
Two questions, for the documentation of a single-collection package in `.zip` format (in the new package system)... * Given that the package is named `mypackage`, must the Scribble file be named `mypackage.scrbl`, or will things work just as well if the file is named `doc.scrbl`? * Scribble-

[racket] raco command extension changed in 6.1?

2014-12-17 Thread Neil Van Dyke
Did how `raco` commands are added change in Racket 6.1? When the following two commands are run under Racket 6.0 or 6.0.1, they show a `raco mcfly` command has been added. But when run under 6.1 or 6.1.1, the `raco mcfly` command has not been added. racket -e '(require (planet neil/mcfly-too

Re: [racket] Making a section optional in Scribble

2014-12-17 Thread Matthew Butterick
The "listification" of arguments within curly braces is easily the aspect of Scribble syntax that trips me up the most. I understand why it's done that way. But for my purposes, I usually want the thing between curly braces to behave as a block, not as a list. For instance, in my Pollen package, I

Re: [racket] Github API in Racket

2014-12-17 Thread Tony Garnock-Jones
Hi Animesh, I have a fork of Sam's code that adds support for a few more API features: https://github.com/tonyg/octokit.rkt Like Sam, I've only added support for those specific API features I needed at the time. Cheers, Tony On 12/12/2014 08:09 PM, Sam Tobin-Hochstadt wrote: > Hi Animesh, >

Re: [racket] using scribble/eval in conjunction with scribble/lp

2014-12-17 Thread Matthew Flatt
The `scribble/lp2` language doesn't include any new support for `examples`. Maybe the code to create and initialize `evaluator` belongs in a library somewhere, though. At Wed, 17 Dec 2014 10:17:57 -0500, Joel McCracken wrote: > OK, so I've gotten a Racket that has scribble/lp2, so Yay. I can > gen

Re: [racket] using scribble/eval in conjunction with scribble/lp

2014-12-17 Thread Joel McCracken
OK, so I've gotten a Racket that has scribble/lp2, so Yay. I can generate documentation with the "Scribble HTML". Do I need to do something to make `@examples` evaluate with the current module? This is what I'm currently using that makes it work: #lang scribble/lp2 @(require scribble/base

Re: [racket] Making a section optional in Scribble

2014-12-17 Thread Eli Barzilay
On Tue, Dec 16, 2014 at 9:27 PM, Matthias Felleisen wrote: > > A 'when' expression returns the value of the last expression, in your > case the content of the section. By lifting the when out, you get both > pieces: [...] After I complained about it a few times, Matthew made it possible to use li