uniform position for unstable header in unstable docs
This commit is contained in:
parent
59beeb2e14
commit
bb93132463
|
@ -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]
|
||||
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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;
|
||||
|
|
|
@ -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.
|
||||
|
||||
|
|
|
@ -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)]{
|
||||
|
|
|
@ -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.
|
||||
|
|
|
@ -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]
|
||||
|
|
|
@ -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}
|
||||
|
|
|
@ -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*]
|
||||
...)
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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]
|
||||
|
|
|
@ -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?))]{
|
||||
|
||||
|
|
|
@ -5,7 +5,6 @@
|
|||
unstable/gui/slideshow))
|
||||
|
||||
@title{Slideshow Presentations}
|
||||
|
||||
@unstable[@author+email["Carl Eastlund" "cce@racket-lang.org"]]
|
||||
|
||||
@defmodule[unstable/gui/slideshow]
|
||||
|
|
|
@ -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?)]
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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?]{
|
||||
|
|
|
@ -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])
|
||||
|
|
|
@ -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 ()]{
|
||||
|
|
|
@ -6,6 +6,7 @@
|
|||
@(the-eval '(require racket/class racket/match unstable/match))
|
||||
|
||||
@title[#:tag "match"]{Match}
|
||||
@unstable-header[]
|
||||
|
||||
@defmodule[unstable/match]
|
||||
|
||||
|
|
|
@ -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]
|
||||
|
|
|
@ -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?]{
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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)].
|
||||
|
|
|
@ -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?)]
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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))]{
|
||||
|
||||
|
|
|
@ -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"]
|
||||
|
|
|
@ -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)
|
||||
|
|
|
@ -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?]
|
||||
|
|
|
@ -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]
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user