From 7a32bda7c9aac0825d0ad9f4ebe95dd02cede5a0 Mon Sep 17 00:00:00 2001 From: Ryan Culpepper Date: Wed, 23 Dec 2009 05:07:59 +0000 Subject: [PATCH] unstable: added consistent doc headers svn: r17390 --- collects/unstable/scribblings/bytes.scrbl | 3 +++ collects/unstable/scribblings/contract.scrbl | 2 ++ collects/unstable/scribblings/exn.scrbl | 3 +++ collects/unstable/scribblings/list.scrbl | 2 ++ collects/unstable/scribblings/mutated-vars.scrbl | 3 ++- collects/unstable/scribblings/net.scrbl | 5 ++++- collects/unstable/scribblings/net/url.scrbl | 3 +++ collects/unstable/scribblings/path.scrbl | 3 +++ collects/unstable/scribblings/poly-c.scrbl | 5 +++-- collects/unstable/scribblings/string.scrbl | 3 +++ collects/unstable/scribblings/utils.ss | 16 +++++++++------- 11 files changed, 37 insertions(+), 11 deletions(-) diff --git a/collects/unstable/scribblings/bytes.scrbl b/collects/unstable/scribblings/bytes.scrbl index 7aec09d12a..8933dd9ae4 100644 --- a/collects/unstable/scribblings/bytes.scrbl +++ b/collects/unstable/scribblings/bytes.scrbl @@ -1,6 +1,7 @@ #lang scribble/doc @(require scribble/base scribble/manual + "utils.ss" (for-label unstable/bytes scheme/serialize scheme/contract @@ -10,6 +11,8 @@ @defmodule[unstable/bytes] +@unstable-header[] + @defproc[(bytes-ci=? [b1 bytes?] [b2 bytes?]) boolean?]{ Compares two bytes case insensitively. } diff --git a/collects/unstable/scribblings/contract.scrbl b/collects/unstable/scribblings/contract.scrbl index 04b981c7e1..b45903e751 100644 --- a/collects/unstable/scribblings/contract.scrbl +++ b/collects/unstable/scribblings/contract.scrbl @@ -10,6 +10,8 @@ @defmodule[unstable/contract] +@unstable-header[] + @defthing[non-empty-string/c contract?]{ Contract for non-empty strings. } diff --git a/collects/unstable/scribblings/exn.scrbl b/collects/unstable/scribblings/exn.scrbl index 548d41fef2..01335e6649 100644 --- a/collects/unstable/scribblings/exn.scrbl +++ b/collects/unstable/scribblings/exn.scrbl @@ -1,6 +1,7 @@ #lang scribble/doc @(require scribble/base scribble/manual + "utils.ss" (for-label unstable/exn scheme/contract scheme/base)) @@ -9,6 +10,8 @@ @defmodule[unstable/exn] +@unstable-header[] + @defproc[(network-error [s symbol?] [fmt string?] [v any/c] ...) diff --git a/collects/unstable/scribblings/list.scrbl b/collects/unstable/scribblings/list.scrbl index aedc04c1b5..9e9c880343 100644 --- a/collects/unstable/scribblings/list.scrbl +++ b/collects/unstable/scribblings/list.scrbl @@ -16,6 +16,8 @@ @defmodule[unstable/list] +@unstable-header[] + @defproc[(list-prefix? [l list?] [r list?]) boolean?]{ diff --git a/collects/unstable/scribblings/mutated-vars.scrbl b/collects/unstable/scribblings/mutated-vars.scrbl index d6dc4b4e13..ac7f8d772a 100644 --- a/collects/unstable/scribblings/mutated-vars.scrbl +++ b/collects/unstable/scribblings/mutated-vars.scrbl @@ -1,5 +1,6 @@ #lang scribble/manual @(require scribble/eval + "utils.ss" (for-label unstable/mutated-vars scheme/contract scheme/base)) @@ -11,7 +12,7 @@ @defmodule[unstable/mutated-vars] -@author[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]] +@unstable[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]] @defproc[(find-mutated-vars [stx syntax?]) void?]{ Traverses diff --git a/collects/unstable/scribblings/net.scrbl b/collects/unstable/scribblings/net.scrbl index 8df640445d..ff4e9c925f 100644 --- a/collects/unstable/scribblings/net.scrbl +++ b/collects/unstable/scribblings/net.scrbl @@ -1,11 +1,14 @@ #lang scribble/doc @(require scribble/base - scribble/manual) + scribble/manual + "utils.ss") @title[#:tag "net" #:style 'toc]{Net} @defmodule[unstable/net] +@unstable-header[] + @local-table-of-contents[] @include-section["net/url.scrbl"] diff --git a/collects/unstable/scribblings/net/url.scrbl b/collects/unstable/scribblings/net/url.scrbl index 3cbf3d58ca..e9f1073fdb 100644 --- a/collects/unstable/scribblings/net/url.scrbl +++ b/collects/unstable/scribblings/net/url.scrbl @@ -1,6 +1,7 @@ #lang scribble/doc @(require scribble/base scribble/manual + "../utils.ss" (for-label unstable/net/url net/url scheme/contract @@ -10,6 +11,8 @@ @defmodule[unstable/net/url] +@unstable-header[] + @defproc[(url-replace-path [proc ((listof path/param?) . -> . (listof path/param?))] [u url?]) url?]{ diff --git a/collects/unstable/scribblings/path.scrbl b/collects/unstable/scribblings/path.scrbl index c886f9398d..4b94d1a633 100644 --- a/collects/unstable/scribblings/path.scrbl +++ b/collects/unstable/scribblings/path.scrbl @@ -1,6 +1,7 @@ #lang scribble/doc @(require scribble/base scribble/manual + "utils.ss" (for-label unstable/path unstable/contract scheme/contract @@ -10,6 +11,8 @@ @defmodule[unstable/path] +@unstable-header[] + @defproc[(explode-path* [p path-string?]) (listof path-element?)]{ Like @scheme[normalize-path], but does not resolve symlinks. diff --git a/collects/unstable/scribblings/poly-c.scrbl b/collects/unstable/scribblings/poly-c.scrbl index 662f13d690..d5b0ff230b 100644 --- a/collects/unstable/scribblings/poly-c.scrbl +++ b/collects/unstable/scribblings/poly-c.scrbl @@ -1,5 +1,6 @@ #lang scribble/manual @(require scribble/eval + "utils.ss" (for-label unstable/poly-c scheme/contract scheme/base)) @@ -11,8 +12,8 @@ @defmodule[unstable/poly-c] -@author[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"] - @author+email["Carl Eastlund" "cce@ccs.neu.edu"]] +@unstable[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"] + @author+email["Carl Eastlund" "cce@ccs.neu.edu"]] @defform[(poly/c ([id+ id-] ...) cnt)]{ diff --git a/collects/unstable/scribblings/string.scrbl b/collects/unstable/scribblings/string.scrbl index 84994de9cb..43363c7474 100644 --- a/collects/unstable/scribblings/string.scrbl +++ b/collects/unstable/scribblings/string.scrbl @@ -1,6 +1,7 @@ #lang scribble/doc @(require scribble/base scribble/manual + "utils.ss" (for-label unstable/string scheme/serialize scheme/contract @@ -10,6 +11,8 @@ @defmodule[unstable/string] +@unstable-header[] + @defproc[(lowercase-symbol! [sb (or/c string? bytes?)]) symbol?]{ Returns @scheme[sb] as a lowercase symbol. diff --git a/collects/unstable/scribblings/utils.ss b/collects/unstable/scribblings/utils.ss index 639f9311c1..bf3c0e393f 100644 --- a/collects/unstable/scribblings/utils.ss +++ b/collects/unstable/scribblings/utils.ss @@ -1,17 +1,19 @@ #lang at-exp scheme/base - (require scribble/base scribble/manual scribble/core) +(provide unstable + unstable-header + addition) -(provide unstable addition) (define (unstable . authors) (make-compound-paragraph plain (list (apply author authors) - @para{This library is @emph{unstable}; - compatibility will not be maintained. - See @secref{unstable} for more information.}))) + (unstable-header)))) + +(define (unstable-header) + @para{This library is @emph{unstable}; + compatibility will not be maintained. + See @secref{unstable} for more information.}) (define (addition name) @margin-note{The subsequent bindings were added by @|name|.}) - -