[plt-scheme] Scribble Problem in PLT Scheme 4.1.5

From: Robby Findler (robby at eecs.northwestern.edu)
Date: Sat Apr 25 11:29:54 EDT 2009

You want square brackets in the itemize, not {} ones. Itemize expects
item arguments only, but with the {} you get spaces and newlines and
things like that as well.

Robby

On Sat, Apr 25, 2009 at 10:04 AM, Doug Williams
<m.douglas.williams at gmail.com> wrote:
> I had the following in the Scribble documentation for the simulation
> collection.
>
> @defproc[(set-insert! (set set?) (item any/c) (priority real? 100)) any]{
> Create a cell containing @scheme[item] and inserts it into @scheme[set] with
> the given @scheme[priority] according to the type of the set.
>
> @itemize{
>   @[email protected][#:fifo]--- at scheme[item] is inserted at the end of
> @scheme[set].  The @scheme[priority], if provided, is ignored.}
>   @[email protected][#:lifo]--- at scheme[item] is inserted at the beginning of
> @scheme[set].  The @scheme[priority], if provided, is ignored.}
>   @[email protected][#:priority]--- at scheme[item] is inserted into @scheme[set]
> according to the @scheme[priority].  If @scheme[priority] is not provided,
> the default value of @math{100} is used.}
>   }}
>
> That worked fine at the time version 3.3 of the simulation collection was
> built. [That was Nov. 27, 2008 according to the SVN log, but I'm not sure
> what version of PLT Scheme I had loaded at that time.] Now it gives a syntax
> error and points to the first item in the itemized list. Removing that one
> just moves the error the the second item.
>
> Moving the itemized list outside of the body of the defproc block removes
> the error. The closing brace (curly bracket) was moved from the end of the
> itemized list up before the itemized list.
>
> @defproc[(set-insert! (set set?) (item any/c) (priority real? 100)) any]{
> Create a cell containing @scheme[item] and inserts it into @scheme[set] with
> the given @scheme[priority] according to the type of the set.}
>
> @itemize{
>   @[email protected][#:fifo]--- at scheme[item] is inserted at the end of
> @scheme[set].  The @scheme[priority], if provided, is ignored.}
>   @[email protected][#:lifo]--- at scheme[item] is inserted at the beginning of
> @scheme[set].  The @scheme[priority], if provided, is ignored.}
>   @[email protected][#:priority]--- at scheme[item] is inserted into @scheme[set]
> according to the @scheme[priority].  If @scheme[priority] is not provided,
> the default value of @math{100} is used.}
>   }
>
> Does anyone know what the problem is?
>
> The real problem is that building the Scribble documents failed when the
> simulation collection was downloaded from PLaneT using PLT Scheme 4.1.5.
> I've updated the PLaneT package so it loads now, but wonder if any other
> packages have a similar problem.
>
> Doug
>
> _________________________________________________
>  For list-related administrative tasks:
>  http://list.cs.brown.edu/mailman/listinfo/plt-scheme
>
>


Posted on the users mailing list.