Some small fixes to the documentation

* Wrong contract for syntax-local-value in the documentation.
* Clarified signature in documentation for expand-import, expand-export and pre-expand-export
* Corrected typo in documentation for "for".
* Fixed error message for function which seems to have been renamed in the docs
* Fixed typo in a comment in the tests
* Fixed a typo in the documentation for set-subtract.
* Use double ellipses for the free-id-table-set*, free-id-table-set*!, bound-id-table-set* and bound-id-table-set*! operations
This commit is contained in:
Georges Dupéron 2016-08-05 17:19:04 +02:00 committed by Vincent St-Amour
parent ddf6985020
commit 153dc01ccd
6 changed files with 18 additions and 18 deletions

View File

@ -29,7 +29,7 @@ Iteratively evaluates @racket[body]s. The @racket[for-clause]s
introduce bindings whose scope includes @racket[body] and that introduce bindings whose scope includes @racket[body] and that
determine the number of times that @racket[body] is evaluated. determine the number of times that @racket[body] is evaluated.
A @racket[break-clause] either among the @racket[for-clause]s A @racket[break-clause] either among the @racket[for-clause]s
of @racket[body]s stops further iteration. or @racket[body]s stops further iteration.
In the simple case, each @racket[for-clause] has one of its first two In the simple case, each @racket[for-clause] has one of its first two
forms, where @racket[[id seq-expr]] is a shorthand for @racket[[(id) forms, where @racket[[id seq-expr]] is a shorthand for @racket[[(id)

View File

@ -545,7 +545,7 @@ Supported for any @racket[st] that @impl{implements} @racket[set-remove!] and @s
@defproc[(set-subtract [st0 generic-set?] [st generic-set?] ...) generic-set?]{ @defproc[(set-subtract [st0 generic-set?] [st generic-set?] ...) generic-set?]{
Produces a set of the same type as @racket[st0] that includes the elements from Produces a set of the same type as @racket[st0] that includes the elements from
@racket[st0] that not contained by any of the @racket[st]s. @racket[st0] that are not contained by any of the @racket[st]s.
If @racket[st0] is a list, each @racket[st] must also be a list. This If @racket[st0] is a list, each @racket[st] must also be a list. This
operation runs on lists in time proportional to the total size of the operation runs on lists in time proportional to the total size of the

View File

@ -569,7 +569,7 @@ the binding creates a binding alias that effectively routes around the
@history[#:added "6.3"]} @history[#:added "6.3"]}
@defproc[(syntax-local-value [id-stx syntax?] @defproc[(syntax-local-value [id-stx identifier?]
[failure-thunk (or/c (-> any) #f) [failure-thunk (or/c (-> any) #f)
#f] #f]
[intdef-ctx (or/c internal-definition-context? [intdef-ctx (or/c internal-definition-context?
@ -577,12 +577,12 @@ the binding creates a binding alias that effectively routes around the
#f]) #f])
any]{ any]{
Returns the @tech{transformer} binding value of @racket[id-stx] in Returns the @tech{transformer} binding value of the identifier
either the context associated with @racket[intdef-ctx] (if not @racket[id-stx] in either the context associated with
@racket[#f]) or the context of the expression being expanded (if @racket[intdef-ctx] (if not @racket[#f]) or the context of the
@racket[intdef-ctx] is @racket[#f]). If @racket[intdef-ctx] is expression being expanded (if @racket[intdef-ctx] is @racket[#f]). If
provided, it must be an extension of the context of the expression @racket[intdef-ctx] is provided, it must be an extension of the
being expanded. context of the expression being expanded.
If @racket[id-stx] is bound to a @tech{rename transformer} created If @racket[id-stx] is bound to a @tech{rename transformer} created
with @racket[make-rename-transformer], @racket[syntax-local-value] with @racket[make-rename-transformer], @racket[syntax-local-value]
@ -1107,7 +1107,7 @@ import sources.
See also @racket[define-require-syntax], which supports macro-style See also @racket[define-require-syntax], which supports macro-style
@racket[require] transformers. @racket[require] transformers.
@defproc[(expand-import [stx syntax?]) @defproc[(expand-import [require-spec syntax?])
(values (listof import?) (values (listof import?)
(listof import-source?))]{ (listof import-source?))]{
@ -1307,7 +1307,7 @@ See also @racket[define-provide-syntax], which supports macro-style
@tech{provide transformers}. @tech{provide transformers}.
@defproc[(expand-export [stx syntax?] [modes (listof (or/c exact-integer? #f))]) @defproc[(expand-export [provide-spec syntax?] [modes (listof (or/c exact-integer? #f))])
(listof export?)]{ (listof export?)]{
Expands the given @racket[_provide-spec] to a list of exports. The Expands the given @racket[_provide-spec] to a list of exports. The
@ -1318,7 +1318,7 @@ form, unless the @racket[modes] list specifies otherwise. Normally,
@racket[modes] is either empty or contains a single element.} @racket[modes] is either empty or contains a single element.}
@defproc[(pre-expand-export [stx syntax?] [modes (listof (or/c exact-integer? #f))]) @defproc[(pre-expand-export [provide-spec syntax?] [modes (listof (or/c exact-integer? #f))])
syntax?]{ syntax?]{
Expands the given @racket[_provide-spec] at the level of @tech{provide Expands the given @racket[_provide-spec] at the level of @tech{provide

View File

@ -1563,7 +1563,7 @@ used in the expression match those given in the earlier definition:
(λ () (λ ()
(raise-syntax-error (raise-syntax-error
'sym-case 'sym-case
"expected an identifier bound via def-sym-case" "expected an identifier bound via define-sym-case"
stx stx
#'id)))) #'id))))
(define actual-ids (syntax->datum #'(sym ...))) (define actual-ids (syntax->datum #'(sym ...)))

View File

@ -146,7 +146,7 @@ Like @racket[hash-set].
@defproc[(free-id-table-set*! [table mutable-free-id-table?] @defproc[(free-id-table-set*! [table mutable-free-id-table?]
[id identifier?] [id identifier?]
[v any/c] ...) [v any/c] ... ...)
void?]{ void?]{
Like @racket[hash-set*!]. Like @racket[hash-set*!].
@ -156,7 +156,7 @@ Like @racket[hash-set*!].
@defproc[(free-id-table-set* [table immutable-free-id-table?] @defproc[(free-id-table-set* [table immutable-free-id-table?]
[id identifier?] [id identifier?]
[v any/c] ...) [v any/c] ... ...)
immutable-free-id-table?]{ immutable-free-id-table?]{
Like @racket[hash-set*]. Like @racket[hash-set*].
@ -322,11 +322,11 @@ etc) can be used on bound-identifier tables.
immutable-bound-id-table?] immutable-bound-id-table?]
@defproc[(bound-id-table-set*! [table mutable-bound-id-table?] @defproc[(bound-id-table-set*! [table mutable-bound-id-table?]
[id identifier?] [id identifier?]
[v any/c] ...) [v any/c] ... ...)
void?] void?]
@defproc[(bound-id-table-set* [table immutable-bound-id-table?] @defproc[(bound-id-table-set* [table immutable-bound-id-table?]
[id identifier?] [id identifier?]
[v any/c] ...) [v any/c] ... ...)
immutable-bound-id-table?] immutable-bound-id-table?]
@defproc[(bound-id-table-remove! [table mutable-bound-id-table?] @defproc[(bound-id-table-remove! [table mutable-bound-id-table?]
[id identifier?]) [id identifier?])

View File

@ -177,7 +177,7 @@
;; ---------------------------------------- ;; ----------------------------------------
;; Check rename-transformer stx-param when used as an expression, ;; Check rename-transformer stx-param when used as an expression,
;; which involves calling the `prop:rename-transformer` is a ;; which involves calling the `prop:rename-transformer` in a
;; `syntax-transforming?` mode ;; `syntax-transforming?` mode
(begin (begin