doc clarifications

This commit is contained in:
Matthew Flatt 2012-06-27 13:20:18 -06:00
parent ec6f3fd610
commit 1d25f698da

View File

@ -141,7 +141,9 @@ includes @racket[constructor-id] as an export. If
@racket[constructor-id] is supplied via @racket[#:constructor-name] @racket[constructor-id] is supplied via @racket[#:constructor-name]
and it is not the same as @racket[id], then @racket[id] does not serve and it is not the same as @racket[id], then @racket[id] does not serve
as a constructor, and @racket[object-name] on the constructor produces as a constructor, and @racket[object-name] on the constructor produces
the symbolic form of @racket[constructor-id]. the symbolic form of @racket[constructor-id]. Only one of
@racket[#:extra-constructor-name] and @racket[#:constructor-name]
can be provided within a @racket[struct] form.
If @racket[#:reflection-name symbol-expr] is provided, then If @racket[#:reflection-name symbol-expr] is provided, then
@racket[symbol-expr] must produce a symbol that is used to identify @racket[symbol-expr] must produce a symbol that is used to identify
@ -230,9 +232,11 @@ position within the structure declaration of the field named by
(id super-id)])]{ (id super-id)])]{
Like @racket[struct], except that the syntax for supplying a Like @racket[struct], except that the syntax for supplying a
@racket[super-id] is different, and a @racket[_constructor-id] that has @racket[super-id] is different, and a @racket[_constructor-id] that
a @racketidfont{make-} prefix on @racket[id] is implicitly supplied has a @racketidfont{make-} prefix on @racket[id] is implicitly
via @racket[#:extra-constructor-name]. supplied via @racket[#:extra-constructor-name] if neither
@racket[#:extra-constructor-name] nor @racket[#:constructor-name] is
provided.
This form is provided for backwards compatibility; @racket[struct] is This form is provided for backwards compatibility; @racket[struct] is
preferred. preferred.