From c22611ca2b947fa695a046d157769ef484a3603b Mon Sep 17 00:00:00 2001 From: Sam Tobin-Hochstadt Date: Thu, 8 Dec 2011 19:20:11 -0500 Subject: [PATCH] Fix documentation to avoid drdr warnings. --- collects/htdp/testing.scrbl | 10 ++++++---- collects/htdp/tests/test-docs-complete.rkt | 22 ++++++++++++---------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/collects/htdp/testing.scrbl b/collects/htdp/testing.scrbl index dbae46f672..945cd6f6c5 100644 --- a/collects/htdp/testing.scrbl +++ b/collects/htdp/testing.scrbl @@ -1,26 +1,28 @@ #lang scribble/doc @(require scribble/manual - (for-label test-engine/racket-tests)) + (for-label test-engine/racket-tests (only-in htdp/testing generate-report))) @title{Testing} @; ----------------------------------------------------------------------------- @defmodule[htdp/testing #:use-sources (test-engine/racket-tests)] -The library re-exports the following identifiers from test-engine/racket-tests: +The library re-exports the following identifiers from @racketmodname[test-engine/racket-tests] +@deftogether[( @defproc[(build-test-engine) void?] @defproc[(builder) void?] @defproc[(display-results) void?] @defproc[(error-handler) void?] @defproc[(exn:fail:wish) void?] -@defproc[(generate-report) void?] @defproc[(get-test-engine) void?] @defproc[(reset-tests) void?] @defproc[(run-tests) void?] @defproc[(scheme-test-data) void?] -@defproc[(signature-test-info%) void?] +@defproc[(signature-test-info%) void?])] + +@defproc[(generate-report) void?]{The same as @racket[test].} @(require scribble/eval diff --git a/collects/htdp/tests/test-docs-complete.rkt b/collects/htdp/tests/test-docs-complete.rkt index 360119f1b3..a17cf12120 100644 --- a/collects/htdp/tests/test-docs-complete.rkt +++ b/collects/htdp/tests/test-docs-complete.rkt @@ -4,6 +4,15 @@ (define (private-module s) #true) (define (legacy-module s) #true) +(define hidden? + (lambda (h) + ;; These identifiers are useful in some tests. They are like + ;; 'friend' in C++ classes. If this weren't a legacy module, I'd + ;; revise the architecture. -- Matthias + (define *hidden + '(draw begin-draw-sequence end-draw-sequence get-@VP get-mouse-event start-and-export)) + (memq h *hidden))) + (check-docs (quote htdp/world)) (check-docs (quote htdp/testing)) (check-docs (quote htdp/show-queen)) @@ -18,22 +27,15 @@ (check-docs (quote htdp/master-play)) (check-docs (quote htdp/lkup-gui)) (check-docs (quote htdp/image)) -(check-docs (quote htdp/hangman)) +(check-docs (quote htdp/hangman) #:skip hidden?) (check-docs (quote htdp/hangman-play)) (check-docs (quote htdp/gui)) (check-docs (quote htdp/guess)) (check-docs (quote htdp/guess-gui)) -(check-docs (quote htdp/graphing)) +(check-docs (quote htdp/graphing) #:skip hidden?) (check-docs (quote htdp/error)) (check-docs (quote htdp/elevator)) -(check-docs (quote htdp/draw) - #:skip (lambda (h) - ;; These identifiers are useful in some tests. They are like - ;; 'friend' in C++ classes. If this weren't a legacy module, I'd - ;; revise the architecture. -- Matthias - (define *hidden - '(draw begin-draw-sequence end-draw-sequence get-@VP get-mouse-event start-and-export)) - (memq h *hidden))) +(check-docs (quote htdp/draw) #:skip hidden?) (check-docs (quote htdp/draw-sig) #:skip private-module) (check-docs (quote htdp/docs)) (check-docs (quote htdp/dir))