basic docs for htdp collection

This commit is contained in:
Matthias Felleisen 2011-05-14 13:56:18 -04:00
parent 490c38ee25
commit 7c546d3b7c

75
collects/htdp/htdp.scrbl Normal file
View File

@ -0,0 +1,75 @@
#lang scribble/doc
@(require scribble/manual (for-label scheme))
@title[#:style '(toc) #:tag "htdp"]{HtDP TeachPacks}
@section{TeachPacks}
TeachPacks for "How to Design Programs" provide functionality that extends
the teaching languages for specific exercises. The extensions fit smoothly
to the teaching languages so that students don't get nonsensical error
messages or undocumented language features through the backdoor.
@; -----------------------------------------------------------------------------
@section{Errors}
@defmodule[htdp/error]
To provide uniform error messages from the TeachPacks, this module
provides several functions:
@defproc[(check-arg) void?]{
}
@defproc[(check-arity) void?]{
}
@defproc[(check-proc) void?]{
}
@defproc[(check-result) void?]{
}
@defproc[(check-list-list) void?]{
}
@defproc[(check-color) void?]{
}
@defproc[(check-fun-res) void?]{
}
@defproc[(check-dependencies) void?]{
}
@defproc[(natural?) void?]{
}
@defproc[(find-non) void?]{
}
@defproc[(tp-exn?) void?]{
}
@defproc[(number->ord) void?]{
}
@section{Testing}
@; -----------------------------------------------------------------------------
@defmodule[htdp/testing #:use-sources (test-engine/scheme-tests)]
The library re-exports the following identifiers from test-engine/scheme-tests:
@scheme[build-test-engine]
@scheme[builder]
@scheme[display-results]
@scheme[error-handler]
@scheme[exn:fail:wish]
@scheme[generate-report]
@scheme[get-test-engine]
@scheme[reset-tests]
@scheme[run-tests]
@scheme[scheme-test-data]
@scheme[signature-test-info%]