From bb93132463cd83b690609b61a2d4a2971d87f160 Mon Sep 17 00:00:00 2001 From: Ryan Culpepper Date: Sun, 18 Dec 2011 14:23:21 -0700 Subject: [PATCH] uniform position for unstable header in unstable docs --- collects/unstable/automata/scribblings/automata.scrbl | 6 +++--- collects/unstable/scribblings/bytes.scrbl | 3 +-- collects/unstable/scribblings/class-iop.scrbl | 3 +-- collects/unstable/scribblings/contract.scrbl | 3 +-- collects/unstable/scribblings/debug.scrbl | 3 +-- collects/unstable/scribblings/define.scrbl | 3 +-- collects/unstable/scribblings/file.scrbl | 3 +-- collects/unstable/scribblings/find.scrbl | 3 +-- collects/unstable/scribblings/function.scrbl | 3 +-- collects/unstable/scribblings/generics.scrbl | 5 ++--- collects/unstable/scribblings/gui/notify.scrbl | 3 +-- collects/unstable/scribblings/gui/pict.scrbl | 1 - collects/unstable/scribblings/gui/prefs.scrbl | 3 +-- collects/unstable/scribblings/gui/slideshow.scrbl | 1 - collects/unstable/scribblings/hash.scrbl | 3 +-- collects/unstable/scribblings/lazy-require.scrbl | 3 +-- collects/unstable/scribblings/list.scrbl | 3 +-- collects/unstable/scribblings/logging.scrbl | 3 +-- collects/unstable/scribblings/markparam.scrbl | 3 +-- collects/unstable/scribblings/match.scrbl | 1 + collects/unstable/scribblings/parameter-group.scrbl | 1 - collects/unstable/scribblings/port.scrbl | 3 +-- collects/unstable/scribblings/pretty.scrbl | 3 +-- collects/unstable/scribblings/sequence.scrbl | 3 +-- collects/unstable/scribblings/string.scrbl | 3 +-- collects/unstable/scribblings/struct.scrbl | 3 +-- collects/unstable/scribblings/syntax.scrbl | 3 +-- collects/unstable/scribblings/unstable.scrbl | 2 +- collects/unstable/scribblings/utils.rkt | 5 +++++ collects/unstable/scribblings/wrapc.scrbl | 7 +++---- collects/unstable/temp-c/scribblings/temp-c.scrbl | 6 +++--- 31 files changed, 39 insertions(+), 59 deletions(-) diff --git a/collects/unstable/automata/scribblings/automata.scrbl b/collects/unstable/automata/scribblings/automata.scrbl index d2a4865076..72981dedb5 100644 --- a/collects/unstable/automata/scribblings/automata.scrbl +++ b/collects/unstable/automata/scribblings/automata.scrbl @@ -2,15 +2,15 @@ @(require scribble/manual scribble/bnf scribble/eval + unstable/scribblings/utils (for-label racket/base racket/contract racket/list)) @(define our-eval (make-base-eval)) -@title{@bold{Automata}: Compiling State Machines} - -@author[@author+email["Jay McCarthy" "jay@racket-lang.org"]] +@title{Automata: Compiling State Machines} +@unstable[@author+email["Jay McCarthy" "jay@racket-lang.org"]] @defmodule[unstable/automata] diff --git a/collects/unstable/scribblings/bytes.scrbl b/collects/unstable/scribblings/bytes.scrbl index e0ef8321c5..7efa3b11c0 100644 --- a/collects/unstable/scribblings/bytes.scrbl +++ b/collects/unstable/scribblings/bytes.scrbl @@ -4,11 +4,10 @@ racket/contract)) @title[#:tag "bytes"]{Bytes} +@unstable-header[] @defmodule[unstable/bytes] -@unstable-header[] - @defproc[(read/bytes [b bytes?]) printable/c]{ @racket[read]s a value from @racket[b] and returns it. diff --git a/collects/unstable/scribblings/class-iop.scrbl b/collects/unstable/scribblings/class-iop.scrbl index 24ea507226..d77b14779b 100644 --- a/collects/unstable/scribblings/class-iop.scrbl +++ b/collects/unstable/scribblings/class-iop.scrbl @@ -10,11 +10,10 @@ @(the-eval '(require racket/class unstable/class-iop (for-syntax racket/base))) @title[#:tag "class-iop"]{Interface-Oriented Programming for Classes} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/class-iop] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defform[(define-interface name-id (super-ifc-id ...) (method-id ...))]{ Defines @racket[name-id] as a static interface extending the diff --git a/collects/unstable/scribblings/contract.scrbl b/collects/unstable/scribblings/contract.scrbl index 1fc75a6a61..9cc84cb9dd 100644 --- a/collects/unstable/scribblings/contract.scrbl +++ b/collects/unstable/scribblings/contract.scrbl @@ -5,11 +5,10 @@ @(the-eval '(require racket/contract racket/dict unstable/contract)) @title[#:tag "contract"]{Contracts} +@unstable-header[] @defmodule[unstable/contract] -@unstable-header[] - @defproc[(non-empty-string? [x any/c]) boolean?]{ Returns @racket[#t] if @racket[x] is a string and is not empty; diff --git a/collects/unstable/scribblings/debug.scrbl b/collects/unstable/scribblings/debug.scrbl index 347278629d..4e637c3172 100644 --- a/collects/unstable/scribblings/debug.scrbl +++ b/collects/unstable/scribblings/debug.scrbl @@ -6,11 +6,10 @@ @(the-eval '(require unstable/debug)) @title{Debugging} +@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/debug] -@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] - This module provides macros and functions for printing out debugging information. diff --git a/collects/unstable/scribblings/define.scrbl b/collects/unstable/scribblings/define.scrbl index 72e742a903..9e8c8c73bd 100644 --- a/collects/unstable/scribblings/define.scrbl +++ b/collects/unstable/scribblings/define.scrbl @@ -7,11 +7,10 @@ @(the-eval '(require unstable/define (for-syntax racket/base))) @title{Definitions} +@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/define] -@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] - Provides macros for creating and manipulating definitions. @defform[(at-end expr)]{ diff --git a/collects/unstable/scribblings/file.scrbl b/collects/unstable/scribblings/file.scrbl index ccc95d436b..e0ba272d51 100644 --- a/collects/unstable/scribblings/file.scrbl +++ b/collects/unstable/scribblings/file.scrbl @@ -8,11 +8,10 @@ racket/base)) @title[#:tag "file"]{Filesystem} +@unstable[@author+email["Jay McCarthy" "jay@racket-lang.org"]] @defmodule[unstable/file] -@unstable[@author+email["Jay McCarthy" "jay@racket-lang.org"]] - @defproc[(make-directory*/ignore-exists-exn [pth path-string?]) void]{ Like @racket[make-directory*], except it ignores errors when the path already exists. Useful to deal with race conditions on processes that create directories. diff --git a/collects/unstable/scribblings/find.scrbl b/collects/unstable/scribblings/find.scrbl index ab73f0e3a6..9ad88a5bc2 100644 --- a/collects/unstable/scribblings/find.scrbl +++ b/collects/unstable/scribblings/find.scrbl @@ -6,11 +6,10 @@ @(the-eval '(require unstable/find racket/shared)) @title[#:tag "find"]{Find} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/find] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defproc[(find [pred (-> any/c any/c)] [x any/c] [#:stop-on-found? stop-on-found? any/c #f] diff --git a/collects/unstable/scribblings/function.scrbl b/collects/unstable/scribblings/function.scrbl index 39274c656d..9cac1e30b0 100644 --- a/collects/unstable/scribblings/function.scrbl +++ b/collects/unstable/scribblings/function.scrbl @@ -5,11 +5,10 @@ @(the-eval '(require unstable/function)) @title{Functions} +@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/function] -@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] - This module provides tools for higher-order programming and creating functions. @section{Higher Order Predicates} diff --git a/collects/unstable/scribblings/generics.scrbl b/collects/unstable/scribblings/generics.scrbl index a0e48eb3f2..1d9a0d81b8 100644 --- a/collects/unstable/scribblings/generics.scrbl +++ b/collects/unstable/scribblings/generics.scrbl @@ -2,12 +2,11 @@ @(require "utils.rkt" (for-label racket/base unstable/generics)) @title{Generics} - -@defmodule[unstable/generics] - @unstable["Eli Barzilay" @author+email["Jay McCarthy" "jay@racket-lang.org"]] +@defmodule[unstable/generics] + @defform/subs[(define-generics (name prop:name name?) [method . kw-formals*] ...) diff --git a/collects/unstable/scribblings/gui/notify.scrbl b/collects/unstable/scribblings/gui/notify.scrbl index 5cc39f274d..9532be9df3 100644 --- a/collects/unstable/scribblings/gui/notify.scrbl +++ b/collects/unstable/scribblings/gui/notify.scrbl @@ -7,11 +7,10 @@ @(the-eval '(require racket/class unstable/private/notify)) @title[#:tag "gui-notify"]{Notify-boxes} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/gui/notify] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defclass[notify-box% object% ()]{ A notify-box contains a mutable cell. The notify-box notifies its diff --git a/collects/unstable/scribblings/gui/pict.scrbl b/collects/unstable/scribblings/gui/pict.scrbl index 28d4568c26..404cacb9e7 100644 --- a/collects/unstable/scribblings/gui/pict.scrbl +++ b/collects/unstable/scribblings/gui/pict.scrbl @@ -14,7 +14,6 @@ @(the-eval '(require racket/math slideshow/pict unstable/gui/pict)) @title[#:tag "pict"]{Pict Utilities} - @unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/gui/pict] diff --git a/collects/unstable/scribblings/gui/prefs.scrbl b/collects/unstable/scribblings/gui/prefs.scrbl index e331c4dbec..7c766b9044 100644 --- a/collects/unstable/scribblings/gui/prefs.scrbl +++ b/collects/unstable/scribblings/gui/prefs.scrbl @@ -5,11 +5,10 @@ racket/base)) @title[#:tag "gui-prefs"]{Preferences} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/gui/prefs] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defproc[(pref:get/set [pref symbol?]) (case-> (-> any/c) (-> any/c void?))]{ diff --git a/collects/unstable/scribblings/gui/slideshow.scrbl b/collects/unstable/scribblings/gui/slideshow.scrbl index a0518b3f82..1c88041a90 100644 --- a/collects/unstable/scribblings/gui/slideshow.scrbl +++ b/collects/unstable/scribblings/gui/slideshow.scrbl @@ -5,7 +5,6 @@ unstable/gui/slideshow)) @title{Slideshow Presentations} - @unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/gui/slideshow] diff --git a/collects/unstable/scribblings/hash.scrbl b/collects/unstable/scribblings/hash.scrbl index 154736a198..fd34a55353 100644 --- a/collects/unstable/scribblings/hash.scrbl +++ b/collects/unstable/scribblings/hash.scrbl @@ -5,11 +5,10 @@ @(the-eval '(require unstable/hash)) @title{Hash Tables} +@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/hash] -@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] - This module provides tools for manipulating hash tables. @defproc[(hash-union [h0 (and/c hash? hash-can-functional-set?)] diff --git a/collects/unstable/scribblings/lazy-require.scrbl b/collects/unstable/scribblings/lazy-require.scrbl index 776d9b53ef..6aec6248d6 100644 --- a/collects/unstable/scribblings/lazy-require.scrbl +++ b/collects/unstable/scribblings/lazy-require.scrbl @@ -6,11 +6,10 @@ unstable/lazy-require)) @title[#:tag "lazy-require"]{Lazy Require} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/lazy-require] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defform/subs[#:literals (unquote) (lazy-require [mod (imported-fun-id ...)] ...) ([mod module-path diff --git a/collects/unstable/scribblings/list.scrbl b/collects/unstable/scribblings/list.scrbl index 749b50d11d..1cb2860499 100644 --- a/collects/unstable/scribblings/list.scrbl +++ b/collects/unstable/scribblings/list.scrbl @@ -7,11 +7,10 @@ @(the-eval '(require unstable/list)) @title[#:tag "list"]{Lists} +@unstable-header[] @defmodule[unstable/list] -@unstable-header[] - @defproc[(list-prefix? [l list?] [r list?]) boolean?]{ diff --git a/collects/unstable/scribblings/logging.scrbl b/collects/unstable/scribblings/logging.scrbl index c78ff4c4ba..358d99a315 100644 --- a/collects/unstable/scribblings/logging.scrbl +++ b/collects/unstable/scribblings/logging.scrbl @@ -5,13 +5,12 @@ @(the-eval '(require unstable/logging)) @title{Logging} +@unstable[@author+email["Vincent St-Amour" "stamourv@racket-lang.org"]] @defmodule[unstable/logging] This module provides tools for logging. -@unstable[@author+email["Vincent St-Amour" "stamourv@racket-lang.org"]] - @defproc[(with-logging-to-port [port output-port?] [proc (-> any)] [#:level level (or/c 'fatal 'error 'warning 'info 'debug) 'debug]) diff --git a/collects/unstable/scribblings/markparam.scrbl b/collects/unstable/scribblings/markparam.scrbl index 433128f925..60b1baefb7 100644 --- a/collects/unstable/scribblings/markparam.scrbl +++ b/collects/unstable/scribblings/markparam.scrbl @@ -2,11 +2,10 @@ @(require "utils.rkt" (for-label racket unstable/markparam)) @title{Mark Parameters} +@unstable[@author+email["Jay McCarthy" "jay@racket-lang.org"]] @defmodule[unstable/markparam] -@unstable[@author+email["Jay McCarthy" "jay@racket-lang.org"]] - This library provides a simplified version of parameters that are backed by continuation marks, rather than parameterizations. This means they are slightly slower, are not inherited by child threads, do not have initial values, and cannot be imperatively mutated. @defstruct*[mark-parameter ()]{ diff --git a/collects/unstable/scribblings/match.scrbl b/collects/unstable/scribblings/match.scrbl index f1edace501..f5ffaea610 100644 --- a/collects/unstable/scribblings/match.scrbl +++ b/collects/unstable/scribblings/match.scrbl @@ -6,6 +6,7 @@ @(the-eval '(require racket/class racket/match unstable/match)) @title[#:tag "match"]{Match} +@unstable-header[] @defmodule[unstable/match] diff --git a/collects/unstable/scribblings/parameter-group.scrbl b/collects/unstable/scribblings/parameter-group.scrbl index ec54a565f9..bfd99f6824 100644 --- a/collects/unstable/scribblings/parameter-group.scrbl +++ b/collects/unstable/scribblings/parameter-group.scrbl @@ -3,7 +3,6 @@ @(require scribble/eval "utils.rkt" (for-label racket unstable/parameter-group)) @title{Parameter Groups} - @unstable[@author+email["Neil Toronto" "ntoronto@racket-lang.org"]] @defmodule[unstable/parameter-group] diff --git a/collects/unstable/scribblings/port.scrbl b/collects/unstable/scribblings/port.scrbl index 010127ccb0..fbc95326be 100644 --- a/collects/unstable/scribblings/port.scrbl +++ b/collects/unstable/scribblings/port.scrbl @@ -5,13 +5,12 @@ @(the-eval '(require unstable/port)) @title{Ports} +@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/port] This module provides tools for port I/O. -@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] - @defproc[(read-all [reader (-> any/c) read] [port input-port? (current-input-port)]) list?]{ diff --git a/collects/unstable/scribblings/pretty.scrbl b/collects/unstable/scribblings/pretty.scrbl index f394557c5e..23d03d080c 100644 --- a/collects/unstable/scribblings/pretty.scrbl +++ b/collects/unstable/scribblings/pretty.scrbl @@ -5,13 +5,12 @@ @(the-eval '(require racket/pretty unstable/pretty)) @title{Pretty-Printing} +@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] @defmodule[unstable/pretty] This module provides tools for pretty-printing. -@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]] - @defproc[(pretty-format/write [x any/c] [columns (or/c exact-nonnegative-integer? 'infinity) diff --git a/collects/unstable/scribblings/sequence.scrbl b/collects/unstable/scribblings/sequence.scrbl index ab044ee7da..c291515800 100644 --- a/collects/unstable/scribblings/sequence.scrbl +++ b/collects/unstable/scribblings/sequence.scrbl @@ -13,11 +13,10 @@ " clause.")])) @title[#:tag "sequence"]{Sequences} +@unstable[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]] @defmodule[unstable/sequence] -@unstable[@author+email["Sam Tobin-Hochstadt" "samth@ccs.neu.edu"]] - @defproc[(in-syntax [stx syntax?]) sequence?]{ Produces a sequence equivalent to @racket[(syntax->list lst)]. diff --git a/collects/unstable/scribblings/string.scrbl b/collects/unstable/scribblings/string.scrbl index 493aa51242..99e3c5308f 100644 --- a/collects/unstable/scribblings/string.scrbl +++ b/collects/unstable/scribblings/string.scrbl @@ -7,11 +7,10 @@ racket/base)) @title[#:tag "string"]{Strings} +@unstable-header[] @defmodule[unstable/string] -@unstable-header[] - @addition{Vincent St-Amour} @defproc[(regexp-filter [pattern (or/c string? bytes? regexp? byte-regexp?)] diff --git a/collects/unstable/scribblings/struct.scrbl b/collects/unstable/scribblings/struct.scrbl index 78a4115128..ab89427313 100644 --- a/collects/unstable/scribblings/struct.scrbl +++ b/collects/unstable/scribblings/struct.scrbl @@ -6,11 +6,10 @@ @(the-eval '(require unstable/struct)) @title[#:tag "struct"]{Structs} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/struct] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defform[(make struct-id expr ...)]{ Creates an instance of @racket[struct-id], which must be bound as a diff --git a/collects/unstable/scribblings/syntax.scrbl b/collects/unstable/scribblings/syntax.scrbl index be57590757..f594be5635 100644 --- a/collects/unstable/scribblings/syntax.scrbl +++ b/collects/unstable/scribblings/syntax.scrbl @@ -7,11 +7,10 @@ @(the-eval '(require unstable/syntax (for-syntax racket/base unstable/syntax))) @title[#:tag "syntax"]{Syntax} +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/syntax] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] - @defproc[(explode-module-path-index [mpi module-path-index?]) (listof (or/c module-path? resolved-module-path? #f))]{ diff --git a/collects/unstable/scribblings/unstable.scrbl b/collects/unstable/scribblings/unstable.scrbl index 21d2e62ace..e01b05bdbd 100644 --- a/collects/unstable/scribblings/unstable.scrbl +++ b/collects/unstable/scribblings/unstable.scrbl @@ -88,8 +88,8 @@ Keep documentation and tests up to date. @include-section["list.scrbl"] @include-section["logging.scrbl"] @include-section["markparam.scrbl"] -@include-section["parameter-group.scrbl"] @include-section["match.scrbl"] +@include-section["parameter-group.scrbl"] @include-section["port.scrbl"] @include-section["pretty.scrbl"] @include-section["sequence.scrbl"] diff --git a/collects/unstable/scribblings/utils.rkt b/collects/unstable/scribblings/utils.rkt index 714bc41085..f600416283 100644 --- a/collects/unstable/scribblings/utils.rkt +++ b/collects/unstable/scribblings/utils.rkt @@ -4,6 +4,11 @@ unstable-header addition) +#| +Place either @unstable or @unstable-header immediately after the +@title form, before any @defmodule form or introductory/summary text. +|# + (define (unstable . authors) (make-compound-paragraph plain (list (apply author authors) diff --git a/collects/unstable/scribblings/wrapc.scrbl b/collects/unstable/scribblings/wrapc.scrbl index d7a2f786eb..50b2824cf3 100644 --- a/collects/unstable/scribblings/wrapc.scrbl +++ b/collects/unstable/scribblings/wrapc.scrbl @@ -6,13 +6,12 @@ @(the-eval '(require racket/contract (for-syntax racket/base unstable/wrapc))) @title[#:tag "wrapc"]{Contracts for Macro Subexpressions} - -This library provides a procedure @racket[wrap-expr/c] for applying -contracts to macro subexpressions. +@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] @defmodule[unstable/wrapc] -@unstable[@author+email["Ryan Culpepper" "ryanc@racket-lang.org"]] +This library provides a procedure @racket[wrap-expr/c] for applying +contracts to macro subexpressions. @defproc[(wrap-expr/c [contract-expr syntax?] [expr syntax?] diff --git a/collects/unstable/temp-c/scribblings/temp-c.scrbl b/collects/unstable/temp-c/scribblings/temp-c.scrbl index b133fcdc3b..2dd257ffd8 100644 --- a/collects/unstable/temp-c/scribblings/temp-c.scrbl +++ b/collects/unstable/temp-c/scribblings/temp-c.scrbl @@ -2,6 +2,7 @@ @(require scribble/manual scribble/bnf scribble/eval + unstable/scribblings/utils (for-label racket/base racket/contract racket/match @@ -9,9 +10,8 @@ @(define our-eval (make-base-eval)) -@title[#:tag "temp-c"]{@bold{Temporal Contracts}: Explicit Contract Monitors} - -@author[@author+email["Jay McCarthy" "jay@racket-lang.org"]] +@title[#:tag "temp-c"]{Temporal Contracts: Explicit Contract Monitors} +@unstable[@author+email["Jay McCarthy" "jay@racket-lang.org"]] @defmodule[unstable/temp-c]