racket/collects/mzlib/scribblings/unit.scrbl
Eli Barzilay d61eb53686 Lots of documentation formatting.
Started as fixing misindented definitions, then more indentations, then
a bunch of similar things (square brackets, huge spaces at end-of-lines,
etc).
2011-08-15 07:50:04 -04:00

56 lines
1.6 KiB
Racket

#lang scribble/doc
@(require "common.rkt"
(for-label mzlib/unit))
@(begin
(define-syntax-rule (bind id)
(begin
(require (for-label racket/unit))
(define id (racket struct))))
(bind racket-struct)
(define-syntax-rule (bindc id)
(begin
(require (for-label racket/unit))
(define id (racket struct/ctc))))
(bindc racket-struct/ctc))
@mzlib[#:mode title unit]
The @racketmodname[mzlib/unit] library mostly re-provides
@racketmodname[racket/unit], except for @racket-struct and
@racket-struct/ctc from @racketmodname[racket/unit].
@defform/subs[(struct id (field-id ...) omit-decl ...)
([omit-decl -type
-selectors
-setters
-constructor])]{
A signature form like @racket-struct from @racketmodname[racket/unit],
but with a different syntax for the options that limit exports.}
@defform/subs[(struct/ctc id ([field-id contract-expr] ...) omit-decl ...)
([omit-decl -type
-selectors
-setters
-constructor])]{
A signature form like @racket-struct/ctc from @racketmodname[racket/unit],
but with a different syntax for the options that limit exports.}
@deftogether[(
@defidform[struct~s]
@defidform[struct~s/ctc]
)]{
The same as @|racket-struct| and @|racket-struct/ctc| from
@racketmodname[racket/unit].}
@deftogether[(
@defidform[struct~r]
@defidform[struct~r/ctc]
)]{
Like @racket[struct~s] and @racket[struct~s/ctc], but the constructor is
named the same as the type, instead of with @racketidfont{make-} prefix.}