From ebabd8d9f9050d872ec2624d4be29689b981848e Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Fri, 27 Feb 2009 01:36:32 +0000 Subject: [PATCH] scribble doc corrections svn: r13866 original commit: ba925a22d91ef4a1f61265c85ba5afb76a1a86c8 --- collects/scribblings/scribble/basic.scrbl | 10 ++++++---- collects/scribblings/scribble/reader.scrbl | 6 +++--- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/collects/scribblings/scribble/basic.scrbl b/collects/scribblings/scribble/basic.scrbl index 7d9bf573..ddf32095 100644 --- a/collects/scribblings/scribble/basic.scrbl +++ b/collects/scribblings/scribble/basic.scrbl @@ -102,11 +102,13 @@ removed.} unnumbered section heading (for when the nesting gets too deep to include in a table of contents).} -@defproc[(itemize [itm (or/c whitespace? an-item?)] ...) itemization?]{ +@defproc[(itemize [itm (or/c whitespace? an-item?)] ... + [#:style style any/c #f]) itemization?]{ - Constructs an itemization given a sequence of items constructed by - @scheme[item]. Whitespace strings among the @scheme[itm]s are - ignored. + Constructs an @scheme[itemization] or (when @scheme[style] is not + @scheme[#f]) @scheme[styled-itemization] given a sequence of items + constructed by @scheme[item]. Whitespace strings among the + @scheme[itm]s are ignored. } diff --git a/collects/scribblings/scribble/reader.scrbl b/collects/scribblings/scribble/reader.scrbl index 97ece334..42b24bdc 100644 --- a/collects/scribblings/scribble/reader.scrbl +++ b/collects/scribblings/scribble/reader.scrbl @@ -16,7 +16,7 @@ The Scribble @"@"-reader is designed to be a convenient facility for using free-form text in Scheme code, where ``@"@"'' is chosen as one of the least-used characters in Scheme code. -You can use the reader via MzScheme's @schemefont{#reader} form: +You can use the reader via Scheme's @schemefont{#reader} form: @schemeblock[ #, @schemefont|{ @@ -29,7 +29,7 @@ or use the @scheme[at-exp] meta-language as described in Note that the Scribble reader reads @"@"-forms as S-expressions. This means that it is up to you to give meanings for these expressions in the usual way: use Scheme functions, define your functions, or require -functions. For example, typing the above into MzScheme is likely +functions. For example, typing the above into @exec{mzscheme} is likely going to produce a ``reference to undefined identifier'' error, unless @scheme[foo] is defined. You can use @scheme[string-append] instead, or you can define @scheme[foo] as a function (with variable arity). @@ -41,7 +41,7 @@ text is likely to start with @schememod[scribble/doc] which installs the @"@" reader starting in ``text mode,'' wraps the -file content afterward into a MzScheme module where many useful Scheme +file content afterward into a Scheme module where many useful Scheme and documentation related functions are available, and parses the body into a document using @schememodname[scribble/decode]. See @secref["docreader"] for more information.