suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix `impersonate-struct' docs

Browse Source 
Move some constraints from `chaperone-struct' docs to `impersonate-struct'
docs.

(Problem reported by Eric Dobson.)
This commit is contained in:
Matthew Flatt 2012-06-23 03:53:35 +08:00
parent 7126295905
commit b951978a77
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
collects/scribblings/reference/chaperones.scrbl
View File

@ -211,7 +211,12 @@ The protocol for a @racket[redirect-proc] depends on the corresponding
Pairs of @racket[prop] and @racket[prop-val] (the number of arguments Pairs of @racket[prop] and @racket[prop-val] (the number of arguments
to @racket[impersonate-struct] must be odd) add impersonator properties to @racket[impersonate-struct] must be odd) add impersonator properties
or override impersonator-property values of @racket[v].} or override impersonator-property values of @racket[v].
Each @racket[orig-proc] must indicate a distinct operation. If no
@racket[orig-proc]s are supplied, then no @racket[prop]s must be
supplied, and @racket[v] is returned unimpersonated.}
@defproc[(impersonate-vector [vec (and/c vector? (not/c immutable?))] @defproc[(impersonate-vector [vec (and/c vector? (not/c immutable?))]
[ref-proc (vector? exact-nonnegative-integer? any/c . -> . any/c)] [ref-proc (vector? exact-nonnegative-integer? any/c . -> . any/c)]
@ -443,16 +448,13 @@ Like @racket[impersonate-struct], but with the following refinements:
corresponding @racket[redirect-proc] must accept two values, corresponding @racket[redirect-proc] must accept two values,
which are the results of @racket[struct-info] on @racket[v]; it which are the results of @racket[struct-info] on @racket[v]; it
must return each values or a chaperone of each value. The must return each values or a chaperone of each value. The
@racket[redirect-proc] is not called if @racket[struct-info] would @racket[redirect-proc] is not called if @racket[struct-info]
return @racket[#f] as its first argument.} would return @racket[#f] as its first argument. An
@racket[orig-proc] can be @racket[struct-info] only if some
other @racket[orig-proc] is supplied.}
] ]}
An @racket[orig-proc] can be @racket[struct-info] only if some other
@racket[orig-proc] is supplied, and each @racket[orig-proc] must
indicate a distinct operation. If no @racket[orig-proc]s are supplied,
then no @racket[prop]s must be supplied, and @racket[v] is returned
unchaperoned.}
@defproc[(chaperone-vector [vec vector?] @defproc[(chaperone-vector [vec vector?]
[ref-proc (vector? exact-nonnegative-integer? any/c . -> . any/c)] [ref-proc (vector? exact-nonnegative-integer? any/c . -> . any/c)]