From 8d02bc884447d46291e2920037b2c0cf8800f603 Mon Sep 17 00:00:00 2001 From: Matthias Felleisen Date: Sun, 24 Jun 2012 17:41:37 -0400 Subject: [PATCH] first stage in documentation reorg (step 2) --- collects/lang/htdp-advanced.rkt | 145 +++++++++++---------- collects/lang/htdp-beginner-abbr.rkt | 107 +++++++-------- collects/lang/htdp-beginner.rkt | 35 +---- collects/lang/htdp-intermediate-lambda.rkt | 122 ++++++++--------- collects/lang/htdp-intermediate.rkt | 127 +++++++++--------- 5 files changed, 261 insertions(+), 275 deletions(-) diff --git a/collects/lang/htdp-advanced.rkt b/collects/lang/htdp-advanced.rkt index 0673617153..9496ac785c 100644 --- a/collects/lang/htdp-advanced.rkt +++ b/collects/lang/htdp-advanced.rkt @@ -1,76 +1,77 @@ -(module htdp-advanced scheme/base - (require "private/teach.rkt" - "private/teach-module-begin.rkt" - mzlib/etc - mzlib/list - mzlib/pretty - syntax/docprovide - scheme/promise - test-engine/scheme-tests - "posn.rkt") +#lang scheme/base - ;; syntax: - (provide (rename-out - [advanced-define define] - [advanced-define-struct define-struct] - [advanced-define-datatype define-datatype] - [advanced-lambda lambda] - [advanced-lambda λ] - [advanced-app #%app] - [beginner-top #%top] - [intermediate-local local] - [advanced-let let] - [intermediate-let* let*] - [intermediate-letrec letrec] - [advanced-recur recur] - [beginner-cond cond] - [beginner-else else] - [beginner-if if] - [beginner-and and] - [beginner-or or] - [beginner-require require] - [beginner-dots ..] - [beginner-dots ...] - [beginner-dots ....] - [beginner-dots .....] - [beginner-dots ......] - [beginner-true true] - [beginner-false false] - [intermediate-quote quote] - [intermediate-quasiquote quasiquote] - [intermediate-unquote unquote] - [intermediate-unquote-splicing unquote-splicing] - [intermediate-time time] - [advanced-begin begin] - [advanced-begin0 begin0] - [advanced-shared shared] - [advanced-set! set!] - [advanced-when when] - [advanced-unless unless] - [advanced-case case] - [advanced-match match] - [advanced-delay delay] - [advanced-module-begin #%module-begin]) - check-expect - check-within - check-error - check-member-of - check-range - #%datum - #%top-interaction - empty +(require "private/teach.rkt" + "private/teach-module-begin.rkt" + mzlib/etc + mzlib/list + mzlib/pretty + syntax/docprovide + scheme/promise + test-engine/scheme-tests + "posn.rkt") - signature : -> mixed one-of predicate combined - Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any - cons-of - Property - check-property for-all ==> expect expect-within expect-member-of expect-range) +(require "private/provide-and-scribble.rkt") - ;; procedures: - (provide-and-document - procedures - (all-from-except intermediate: lang/htdp-intermediate-lambda procedures - cons list* append random) - (all-from advanced: lang/private/advanced-funs procedures)) - ) +;; syntax: +(provide (rename-out + [advanced-define define] + [advanced-define-struct define-struct] + [advanced-define-datatype define-datatype] + [advanced-lambda lambda] + [advanced-lambda λ] + [advanced-app #%app] + [beginner-top #%top] + [intermediate-local local] + [advanced-let let] + [intermediate-let* let*] + [intermediate-letrec letrec] + [advanced-recur recur] + [beginner-cond cond] + [beginner-else else] + [beginner-if if] + [beginner-and and] + [beginner-or or] + [beginner-require require] + [beginner-dots ..] + [beginner-dots ...] + [beginner-dots ....] + [beginner-dots .....] + [beginner-dots ......] + [beginner-true true] + [beginner-false false] + [intermediate-quote quote] + [intermediate-quasiquote quasiquote] + [intermediate-unquote unquote] + [intermediate-unquote-splicing unquote-splicing] + [intermediate-time time] + [advanced-begin begin] + [advanced-begin0 begin0] + [advanced-shared shared] + [advanced-set! set!] + [advanced-when when] + [advanced-unless unless] + [advanced-case case] + [advanced-match match] + [advanced-delay delay] + [advanced-module-begin #%module-begin]) + check-expect + check-within + check-error + check-member-of + check-range + #%datum + #%top-interaction + empty + + signature : -> mixed one-of predicate combined + Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any + cons-of + Property + check-property for-all ==> expect expect-within expect-member-of expect-range) + +;; procedures: +(provide-and-scribble + procedures + (all-from-except intermediate: lang/private/intermediate-funs procedures cons list* append random) + (all-from advanced: lang/private/advanced-funs procedures)) diff --git a/collects/lang/htdp-beginner-abbr.rkt b/collects/lang/htdp-beginner-abbr.rkt index cb66a54676..21a282f4c6 100644 --- a/collects/lang/htdp-beginner-abbr.rkt +++ b/collects/lang/htdp-beginner-abbr.rkt @@ -1,58 +1,59 @@ -(module htdp-beginner-abbr scheme/base - (require mzlib/etc - mzlib/list - mzlib/math - syntax/docprovide - test-engine/scheme-tests) +#lang scheme/base - ;; Implements the forms: - (require "private/teach.rkt" - "private/teach-module-begin.rkt") +(require mzlib/etc + mzlib/list + mzlib/math + syntax/docprovide + test-engine/scheme-tests) - ;; syntax: - (provide (rename-out - [beginner-define define] - [beginner-define-struct define-struct] - [beginner-lambda lambda] - [beginner-app #%app] - [beginner-top #%top] - [beginner-cond cond] - [beginner-else else] - [beginner-if if] - [beginner-and and] - [beginner-or or] - [beginner-require require] - [beginner-dots ..] - [beginner-dots ...] - [beginner-dots ....] - [beginner-dots .....] - [beginner-dots ......] - [intermediate-quote quote] - [intermediate-quasiquote quasiquote] - [intermediate-unquote unquote] - [intermediate-unquote-splicing unquote-splicing] - [beginner-module-begin #%module-begin] - [beginner-true true] - [beginner-false false]) - check-expect - check-within - check-error - check-member-of - check-range - #%datum - #%top-interaction - empty +(require "private/provide-and-scribble.rkt") -; signature : -> mixed one-of predicate combined -; Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any -; cons-of -; Property -; check-property for-all ==> expect expect-within expect-member-of expect-range - ) +;; Implements the forms: +(require "private/teach.rkt" + "private/teach-module-begin.rkt") - ;; procedures: - (provide-and-document - procedures - (all-from beginner: lang/htdp-beginner procedures)) +;; syntax: +(provide (rename-out + [beginner-define define] + [beginner-define-struct define-struct] + [beginner-lambda lambda] + [beginner-app #%app] + [beginner-top #%top] + [beginner-cond cond] + [beginner-else else] + [beginner-if if] + [beginner-and and] + [beginner-or or] + [beginner-require require] + [beginner-dots ..] + [beginner-dots ...] + [beginner-dots ....] + [beginner-dots .....] + [beginner-dots ......] + [intermediate-quote quote] + [intermediate-quasiquote quasiquote] + [intermediate-unquote unquote] + [intermediate-unquote-splicing unquote-splicing] + [beginner-module-begin #%module-begin] + [beginner-true true] + [beginner-false false]) + check-expect + check-within + check-error + check-member-of + check-range + #%datum + #%top-interaction + empty + + ; signature : -> mixed one-of predicate combined + ; Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any + ; cons-of + ; Property + ; check-property for-all ==> expect expect-within expect-member-of expect-range + ) - ) +;; procedures: +(provide-and-scribble + procedures + (all-from beginner: (submod "private/beginner-funs.rkt" with-wrapper) procedures)) diff --git a/collects/lang/htdp-beginner.rkt b/collects/lang/htdp-beginner.rkt index 26c2e60e65..903675c868 100644 --- a/collects/lang/htdp-beginner.rkt +++ b/collects/lang/htdp-beginner.rkt @@ -10,6 +10,9 @@ (for-syntax "private/rewrite-error-message.rkt") (for-syntax scheme/base)) +(require "private/provide-and-scribble.rkt") + + ;; Implements the forms: (require "private/teach.rkt" "private/teach-module-begin.rkt" @@ -54,34 +57,8 @@ ; Property ; check-property for-all ==> expect expect-within expect-member-of expect-range ) - -(require (for-syntax "private/firstorder.rkt")) - - -(define-syntax (in-rator-position-only stx) - (syntax-case stx () - [(_ new-name orig-name) - (let ([new (syntax new-name)] - [orig (syntax orig-name)]) - ;; Some things are not really functions: - (if (memq (syntax-e orig) '(beginner:pi beginner:e beginner:null beginner:eof)) - #'(define new-name orig-name) - #'(define-syntax new-name - (make-first-order - (lambda (stx) - (syntax-case stx () - [(id . args) - (syntax/loc stx (beginner-app orig-name . args))] - [_else - (raise-syntax-error - #f - (format - "expected a function call, but there is no open parenthesis before this function") - stx)])) - #'orig-name))))])) - + ;; procedures: -(provide-and-document/wrap +(provide-and-scribble procedures - in-rator-position-only - (all-from beginner: lang/private/beginner-funs procedures)) + (all-from beginner: (submod "private/beginner-funs.rkt" with-wrapper) procedures)) diff --git a/collects/lang/htdp-intermediate-lambda.rkt b/collects/lang/htdp-intermediate-lambda.rkt index cf3cf371dc..de07b720c9 100644 --- a/collects/lang/htdp-intermediate-lambda.rkt +++ b/collects/lang/htdp-intermediate-lambda.rkt @@ -1,62 +1,66 @@ -(module htdp-intermediate-lambda scheme/base - (require "private/teach.rkt" - "private/teach-module-begin.rkt" - mzlib/etc - mzlib/list - syntax/docprovide - test-engine/scheme-tests) +#lang scheme/base - ;; syntax: - (provide (rename-out - [intermediate-lambda-define define] - [intermediate-define-struct define-struct] - [intermediate-lambda lambda] - [intermediate-lambda λ] - [advanced-app #%app] - [beginner-top #%top] - [intermediate-local local] - [intermediate-let let] - [intermediate-let* let*] - [intermediate-letrec letrec] - [intermediate-recur recur] - [beginner-cond cond] - [beginner-else else] - [beginner-if if] - [beginner-and and] - [beginner-or or] - [beginner-require require] - [beginner-dots ..] - [beginner-dots ...] - [beginner-dots ....] - [beginner-dots .....] - [beginner-dots ......] - [intermediate-quote quote] - [intermediate-quasiquote quasiquote] - [intermediate-unquote unquote] - [intermediate-unquote-splicing unquote-splicing] - [intermediate-time time] - [intermediate-module-begin #%module-begin] - [beginner-true true] - [beginner-false false] - ) - check-expect - check-within - check-error - check-member-of - check-range - #%datum - #%top-interaction - empty +(require "private/teach.rkt" + "private/teach-module-begin.rkt" + mzlib/etc + mzlib/list + syntax/docprovide + test-engine/scheme-tests) + +(require "private/provide-and-scribble.rkt") + +;; syntax: +(provide (rename-out + [intermediate-lambda-define define] + [intermediate-define-struct define-struct] + [intermediate-lambda lambda] + [intermediate-lambda λ] + [advanced-app #%app] + [beginner-top #%top] + [intermediate-local local] + [intermediate-let let] + [intermediate-let* let*] + [intermediate-letrec letrec] + [intermediate-recur recur] + [beginner-cond cond] + [beginner-else else] + [beginner-if if] + [beginner-and and] + [beginner-or or] + [beginner-require require] + [beginner-dots ..] + [beginner-dots ...] + [beginner-dots ....] + [beginner-dots .....] + [beginner-dots ......] + [intermediate-quote quote] + [intermediate-quasiquote quasiquote] + [intermediate-unquote unquote] + [intermediate-unquote-splicing unquote-splicing] + [intermediate-time time] + [intermediate-module-begin #%module-begin] + [beginner-true true] + [beginner-false false] + ) + check-expect + check-within + check-error + check-member-of + check-range + #%datum + #%top-interaction + empty + + ; signature : -> mixed one-of predicate combined + ; Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any + ; cons-of + ; Property + ; check-property for-all ==> expect expect-within expect-member-of expect-range + ) + +;; procedures: +(provide-and-scribble + procedures + (all-from intermediate: lang/private/intermediate-funs procedures)) -; signature : -> mixed one-of predicate combined -; Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any -; cons-of -; Property -; check-property for-all ==> expect expect-within expect-member-of expect-range - ) - ;; procedures: - (provide-and-document - procedures - (all-from intermediate: lang/htdp-intermediate procedures)) - ) diff --git a/collects/lang/htdp-intermediate.rkt b/collects/lang/htdp-intermediate.rkt index 8f460ce84a..cbdbc06d95 100644 --- a/collects/lang/htdp-intermediate.rkt +++ b/collects/lang/htdp-intermediate.rkt @@ -1,67 +1,70 @@ -(module htdp-intermediate scheme/base +#lang scheme/base - (require "private/teach.rkt" - "private/teachprims.rkt" - "private/teach-module-begin.rkt" - mzlib/etc - mzlib/list - syntax/docprovide - test-engine/scheme-tests - (for-syntax scheme/base)) +(require "private/teach.rkt" + "private/teachprims.rkt" + "private/teach-module-begin.rkt" + mzlib/etc + mzlib/list + syntax/docprovide + test-engine/scheme-tests + (for-syntax scheme/base)) - ;; syntax: - (provide (rename-out - [intermediate-define define] - [intermediate-define-struct define-struct] - [intermediate-pre-lambda lambda] - [intermediate-app #%app] - [beginner-top #%top] - [intermediate-local local] - [intermediate-let let] - [intermediate-let* let*] - [intermediate-letrec letrec] - ;; [intermediate-recur recur] - [beginner-cond cond] - [beginner-else else] - [beginner-if if] - [beginner-and and] - [beginner-or or] - [beginner-require require] - [beginner-dots ..] - [beginner-dots ...] - [beginner-dots ....] - [beginner-dots .....] - [beginner-dots ......] - [intermediate-quote quote] - [intermediate-quasiquote quasiquote] - [intermediate-unquote unquote] - [intermediate-unquote-splicing unquote-splicing] - [intermediate-time time] - [intermediate-module-begin #%module-begin] - [beginner-true true] - [beginner-false false] - ) - check-expect - check-within - check-error - check-member-of - check-range - #%datum - #%top-interaction - empty +(require "private/provide-and-scribble.rkt") -; signature : -> mixed one-of predicate combined -; Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any -; cons-of -; Property -; check-property for-all ==> expect expect-within expect-member-of expect-range - ) +;; syntax: +(provide (rename-out + [intermediate-define define] + [intermediate-define-struct define-struct] + [intermediate-pre-lambda lambda] + [intermediate-app #%app] + [beginner-top #%top] + [intermediate-local local] + [intermediate-let let] + [intermediate-let* let*] + [intermediate-letrec letrec] + ;; [intermediate-recur recur] + [beginner-cond cond] + [beginner-else else] + [beginner-if if] + [beginner-and and] + [beginner-or or] + [beginner-require require] + [beginner-dots ..] + [beginner-dots ...] + [beginner-dots ....] + [beginner-dots .....] + [beginner-dots ......] + [intermediate-quote quote] + [intermediate-quasiquote quasiquote] + [intermediate-unquote unquote] + [intermediate-unquote-splicing unquote-splicing] + [intermediate-time time] + [intermediate-module-begin #%module-begin] + [beginner-true true] + [beginner-false false] + ) + check-expect + check-within + check-error + check-member-of + check-range + #%datum + #%top-interaction + empty + + ; signature : -> mixed one-of predicate combined + ; Number Real Rational Integer Natural Boolean True False String Symbol Char Empty-list Any + ; cons-of + ; Property + ; check-property for-all ==> expect expect-within expect-member-of expect-range + ) - (provide-and-document - procedures - (all-from beginner: lang/private/intermediate-funs procedures)) - (provide - (rename-out - [beginner-list? list?])) - ) +(provide-and-scribble + procedures + (all-from beginner: lang/private/intermediate-funs procedures)) + +(provide + (rename-out + [beginner-list? list?])) +