Unless it is about the _implementation_ of the module, I think that belongs in the first paragraph of the docs instead.
Robby On Sun, Aug 14, 2011 at 9:48 PM, Matthias Felleisen <[email protected]> wrote: > > I am following the guidelines now :-) > > I actually do think a one-line purpose statement per module is a *good* idea. > > > On Aug 14, 2011, at 10:46 PM, Robby Findler wrote: > >> On Sun, Aug 14, 2011 at 9:29 PM, <[email protected]> wrote: >>> collects/lang/htdp-langs-save-file-prefix.rkt >>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ >>> --- OLD/collects/lang/htdp-langs-save-file-prefix.rkt >>> +++ NEW/collects/lang/htdp-langs-save-file-prefix.rkt >>> @@ -1,11 +1,16 @@ >>> #lang racket/base >>> -(require racket/contract >>> + >>> +;; >>> --------------------------------------------------------------------------------------------------- >>> +;; exports the header for a file saved from a drracket buffer in a >>> menu-selected teaching language >>> + >>> +(require racket/contract >>> racket/port) >> >> The above stuff is explained in the documentation, no? (If you think >> it wasn't clear enough, then an edit belongs in the docs, not here, >> imo) >> >> Thanks for the fix below. >> >>> (provide/contract >>> [htdp-save-file-prefix (listof string?)] >>> [htdp-file-prefix? (-> input-port? boolean?)]) >>> >>> + >>> (define htdp-save-file-prefix >>> (list ";; The first three lines of this file were inserted by DrRacket. >>> They record metadata" >>> ";; about the language level of this file in a form that our tools >>> can easily process.")) >>> @@ -27,8 +32,7 @@ >>> (cond >>> [(null? prefix) >>> (define l (read-line port 'any)) >>> - (and (string? l) >>> - (regexp-match #rx"^#reader" l))] >>> + (and (string? l) (pair? (regexp-match #rx"^#reader" l)))] >>> [else >>> (define l (read-line port 'any)) >>> (and (string? l) >>> > > _________________________________________________ For list-related administrative tasks: http://lists.racket-lang.org/listinfo/dev
