Fix missing documentation of alias forms.

This commit is contained in:
Sam Tobin-Hochstadt 2011-06-21 15:17:22 -04:00
parent fbc76a3074
commit d8c972734d
2 changed files with 28 additions and 2 deletions

View File

@ -1,8 +1,8 @@
#lang scribble/manual #lang scribble/manual
@begin[(require "../utils.rkt" scribble/eval racket/sandbox) @begin[(require "../utils.rkt" scribble/eval racket/sandbox)
(require (for-label (only-meta-in 0 [except-in typed/racket for]) (require (for-label (only-meta-in 0 [except-in typed/racket])
(only-in racket/base for)))] (only-in racket/base)))]
@(define the-eval (make-base-eval)) @(define the-eval (make-base-eval))
@(the-eval '(require (except-in typed/racket #%top-interaction #%module-begin))) @(the-eval '(require (except-in typed/racket #%top-interaction #%module-begin)))
@ -13,6 +13,15 @@
(examples #:eval the-top-eval . args)) (examples #:eval the-top-eval . args))
@(define-syntax-rule (def-racket for-id for*-id with-handlers-id)
(begin
(require (for-label (only-in racket/base for for* with-handlers)))
(define for-id (racket for))
(define for*-id (racket for*))
(define with-handlers-id (racket with-handlers))))
@(def-racket for-id for*-id with-handlers-id)
@title[#:tag "special-forms"]{Special Form Reference} @title[#:tag "special-forms"]{Special Form Reference}
Typed Racket provides a variety of special forms above and beyond Typed Racket provides a variety of special forms above and beyond
@ -178,6 +187,12 @@ These behave like their non-annotated counterparts. Unlike the above,
These behave like their non-annotated counterparts. These behave like their non-annotated counterparts.
} }
@deftogether[[
@defidform[for]
@defidform[for*]]]{
These are identical to @|for-id| and @|for*-id|, but provide additional annotations to help the typechecker.
}
@defform/subs[(do: : u ([id : t init-expr step-expr-maybe] ...) @defform/subs[(do: : u ([id : t init-expr step-expr-maybe] ...)
(stop?-expr finish-expr ...) (stop?-expr finish-expr ...)
expr ...+) expr ...+)
@ -366,4 +381,10 @@ a @racket[require/typed] form. Here is an example of using
@racket[file-or-directory-modify-seconds] has some arguments which are optional, @racket[file-or-directory-modify-seconds] has some arguments which are optional,
so we need to use @racket[case->].} so we need to use @racket[case->].}
@section{Other Forms}
@defidform[with-handlers]{
Identical to @|with-handlers-id|, but provides additional annotations to help the typechecker.
}
@(close-eval the-eval) @(close-eval the-eval)

View File

@ -126,6 +126,7 @@ default in Racket.
@defidform[Port] @defidform[Port]
@defidform[Path] @defidform[Path]
@defidform[Path-String] @defidform[Path-String]
@defidform[Path-For-Some-System]
@defidform[Regexp] @defidform[Regexp]
@defidform[PRegexp] @defidform[PRegexp]
@defidform[Byte-Regexp] @defidform[Byte-Regexp]
@ -141,6 +142,10 @@ default in Racket.
@defidform[Module-Path-Index] @defidform[Module-Path-Index]
@defidform[Compiled-Module-Expression] @defidform[Compiled-Module-Expression]
@defidform[Resolved-Module-Path] @defidform[Resolved-Module-Path]
@defidform[Pretty-Print-Style-Table]
@defidform[Special-Comment]
@defidform[Struct-Type-Property]
@defidform[Read-Table]
@defidform[Thread])]{ @defidform[Thread])]{
These types represent primitive Racket data. These types represent primitive Racket data.