There are several things about the excellent scribble guide at

http://docs.racket-lang.org/scribble/getting-started.html

that appear not to have been edited since the pre-Butterick era. Since this is 
now year B3 or B4, it seems high time to edit them.

Specifically, the documentation manages to give the impression that the output 
produced by scribble is *different* from the lovely output that the reader is 
viewing.

1) It doesn’t say the obvious: “this text is rendered using scribble.”
2) The example file, when rendered with the commands given, produces “classic” 
output which is (forgive me) way way less attractive than the Butterick style.
3) Finally, the documentation actually out-and-out says "Scribble currently 
supports only one form of HTML output. You can replace the "scribble.css" file 
for the generated pages, and that’s about it. (We expect to add more styles in 
the future.)” Which just isn’t true.

At a minimum, I think we should address points 1 and 3, which are just doc 
fixes.

However, I’m not aware of any good reasons not to make the Butterick style the 
default; I always use #lang scribble/manual to get it, and perhaps there’s some 
compelling reason why the current default should be the default, but if not, 
maybe we should change it?

I’m happy to make a pull request on the docs, but the doc suggestions might be 
different if we decide to make the Butterick style the default.

John



-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to