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

clarify `define-struct/derived' in docs

Browse Source
This commit is contained in:
Matthew Flatt 2011-09-03 13:21:38 -06:00
parent 4025206bd7
commit 1c34ce9f19
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
collects/scribblings/reference/define-struct.scrbl
View File

@ -236,11 +236,12 @@ preferred.
@defform[(define-struct/derived (id . rest-form)
id-maybe-super (field ...) struct-option ...)]{
Like @racket[define-struct], but intended for use by macros that
expand to @racket[define-struct]. The form immediately after
@racket[define-struct/derived] is used for all syntax-error reporting,
and the only constraint on the form is that it starts with some
@racket[id].
The same as @racket[define-struct], but with an extra @racket[(id
. rest-form)] sub-form that is treated as the overall form for
syntax-error reporting and otherwise ignored. The only constraint on
the sub-form for error reporting is that it starts with @racket[id].
The @racket[define-struct/derived] form is intended for use by macros
that expand to @racket[define-struct].
@defexamples[
#:eval posn-eval