suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

scribble doc corrections

Browse Source 
svn: r13866

original commit: ba925a22d91ef4a1f61265c85ba5afb76a1a86c8
This commit is contained in:
Matthew Flatt 2009-02-27 01:36:32 +00:00
parent d9edf185bf
commit ebabd8d9f9
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
collects/scribblings/scribble/basic.scrbl
View File

@ -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.
}

6
collects/scribblings/scribble/reader.scrbl
View File

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