From 5592dd1489ef5c84a22e954dd1a08ccf34bbe87e Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Mon, 31 May 2010 13:16:51 -0600 Subject: [PATCH] doc corrections Merge to 5.0 --- collects/scribblings/foreign/define.scrbl | 18 +++++++++--------- collects/scribblings/scribble/scheme.scrbl | 14 +++++++------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/collects/scribblings/foreign/define.scrbl b/collects/scribblings/foreign/define.scrbl index 8de143f2c7..685b0a7446 100644 --- a/collects/scribblings/foreign/define.scrbl +++ b/collects/scribblings/foreign/define.scrbl @@ -31,21 +31,21 @@ The other options support further wrapping and configuration: @itemize[ - @item{Before the extracted result is bound as @scheme[id], it is - passed to the result of @scheme[wrap-expr], which defaults to + @item{Before the extracted result is bound as @scheme[_id], it is + passed to the result of @scheme[_wrap-expr], which defaults to @scheme[values]. Expressions such as @scheme[(allocator _delete)] or @scheme[(deallocator)] are useful as - @scheme[wrap-expr]s.} + @scheme[_wrap-expr]s.} @item{The @scheme[#:make-fail] and @scheme[#:fail] options are - mutually exclusive; if @scheme[make-fail-expr] is provided, it - is applied to @scheme['#,@scheme[id]] to obtain the last - argument to @scheme[get-ffi-obj]; if @scheme[fail-expr] is + mutually exclusive; if @scheme[_make-fail-expr] is provided, it + is applied to @scheme['@#,scheme[_id]] to obtain the last + argument to @scheme[get-ffi-obj]; if @scheme[_fail-expr] is provided, it is supplied directly as the last argument to @scheme[get-ffi-obj]. The @scheme[make-not-available] function - is useful as @scheme[make-fail-expr] to cause a use of - @scheme[id] to report an error when it is applied if - @scheme[c-id] was not found in the foreign library.} + is useful as @scheme[_make-fail-expr] to cause a use of + @scheme[_id] to report an error when it is applied if + @scheme[_c-id] was not found in the foreign library.} ] diff --git a/collects/scribblings/scribble/scheme.scrbl b/collects/scribblings/scribble/scheme.scrbl index 7925e3219e..5db7a498c4 100644 --- a/collects/scribblings/scribble/scheme.scrbl +++ b/collects/scribblings/scribble/scheme.scrbl @@ -43,7 +43,7 @@ The @racket[stx-prop-expr] should produce a procedure for recording a @racket[id] has such a property. The default is @racket[syntax-property].} -@defproc[(to-paragraph [v any/c] [#:qq? qq? any/c #f]) block?]{ +@defproc[(to-paragraph [v any/c] [#:expr? expr? any/c #f]) block?]{ Typesets an S-expression that is represented by a syntax object, where source-location information in the syntax object controls the @@ -63,15 +63,15 @@ In addition, the given @racket[v] can contain @racket[var-id], structure type for details), or it can contain @racket[element] structures that are used directly in the output. -If @racket[qq?] is true, then @racket[v] is rendered ``quasiquote'' -style, much like @racket[print] with the @racket[print-as-quasiquote] +If @racket[expr?] is true, then @racket[v] is rendered in expression +style, much like @racket[print] with the @racket[print-as-expression] parameter set to @racket[#t]. In that case, @racket[for-label] bindings on identifiers are ignored, since the identifiers are all -quoted in the output. Typically, @racket[qq?] is set to true for +quoted in the output. Typically, @racket[expr?] is set to true for printing result values.} -@defproc[((to-paragraph/prefix [prefix1 any/c] [prefix any/c] [suffix any/c] [#:qq? qq? any/c #f]) +@defproc[((to-paragraph/prefix [prefix1 any/c] [prefix any/c] [suffix any/c] [#:expr? expr? any/c #f]) [v any/c]) block?]{ @@ -83,13 +83,13 @@ first line, @racket[prefix] is prefix to any subsequent line, and it is added to the end on its own line.} -@defproc[(to-element [v any/c] [#:qq? qq? any/c #f]) element?]{ +@defproc[(to-element [v any/c] [#:expr? expr? any/c #f]) element?]{ Like @racket[to-paragraph], except that source-location information is mostly ignored, since the result is meant to be inlined into a paragraph.} -@defproc[(to-element/no-color [v any/c] [#:qq? qq? any/c #f]) element?]{ +@defproc[(to-element/no-color [v any/c] [#:expr? expr? any/c #f]) element?]{ Like @racket[to-element], but @racket[for-syntax] bindings are ignored, and the generated text is uncolored. This variant is