Fix documentation for packages and mutable lists.

As suggested by Matthew.
This commit is contained in:
Vincent St-Amour 2012-07-31 16:34:29 -04:00
parent cc8a9b5ed7
commit 800a328fe6
17 changed files with 18 additions and 40 deletions

View File

@ -15,7 +15,7 @@ We @emph{strongly} recommend using these alternatives.
@include-section["defmacro.scrbl"]
@include-section["package.scrbl"]
@include-section["mpairs.scrbl"]
@include-section["mlists.scrbl"]
@(bibliography
(bib-entry #:key "Waddell99"

View File

@ -1,14 +1,14 @@
#lang scribble/doc
@(require scribblings/reference/mz scribble/racket
(for-label compatibility/mpair))
(for-label compatibility/mlist))
@title[#:tag "mlists"]{Mutable List Functions}
@(define reference '(lib "scribblings/reference/reference.scrbl"))
@defmodule[compatibility/mpair]
@defmodule[compatibility/mlist]
This @racketmodname[compatibility/mpair] library provides support for
This @racketmodname[compatibility/mlist] library provides support for
@tech[#:doc reference]{mutable list}s.
Support is provided primarily to help porting Lisp/Scheme code to Racket.

View File

@ -7,7 +7,7 @@
racket/list ; for use in specs too
racket/string
racket/file (only-in racket/system system)
(except-in compatibility/mpair mappend)
(except-in compatibility/mlist mappend)
meta/checker (prefix-in dist: meta/dist-specs) meta/specs)
(define (/-ify x)

View File

@ -2,7 +2,7 @@
(module pconvert mzscheme
(require (only racket/base sort)
compatibility/mpair
compatibility/mlist
"pconvert-prop.rkt"
"class.rkt")

View File

@ -153,7 +153,7 @@ export from a module that is implemented in an @|r5rs|-like language.
The @racket[cons] of @racketmodname[r5rs] corresponds to
@racketmodname[racket/base]'s @racket[mcons]. Similarly, @racket[cdr]
is @racket[mcdr], and @racket[map] is @racketmodname[compatibility/mpair]'s
is @racket[mcdr], and @racket[map] is @racketmodname[compatibility/mlist]'s
@racket[mmap], and so on.
An @|r5rs| @defterm{environment} is implemented as a

View File

@ -1,6 +1,6 @@
#lang racket/base
;; compatibility library, see compatibility/mpair
;; compatibility library, see compatibility/mlist
(require compatibility/mpair)
(provide (all-from-out compatibility/mpair))
(require compatibility/mlist)
(provide (all-from-out compatibility/mlist))

View File

@ -50,12 +50,3 @@ Changes the @tech{mutable pair} @racket[p] so that its first element is
Changes the @tech{mutable pair} @racket[p] so that its second element is
@racket[v].}
@; ----------------------------------------
@section{Mutable List Functions}
@note-lib-only[racket/mpair]
@deprecated[@racketmodname[compatibility/mpair]]{}
Re-exports @racketmodname[compatibility/mpair].

View File

@ -1,10 +0,0 @@
#lang scribble/doc
@(require "mz.rkt" (for-label racket/package compatibility/package))
@title[#:tag "package"]{Limiting Scope: @racket[define-package], @racket[open-package], ...}
@note-lib-only[racket/package]
@deprecated[@racketmodname[compatibility/package]]{}
Re-exports @racketmodname[compatibility/package].

View File

@ -3,7 +3,7 @@
(for-syntax racket/base)
(for-label racket/generator
racket/generic
compatibility/mpair))
compatibility/mlist))
@(define (info-on-seq where what)
@margin-note{See @secref[where] for information on using @|what| as

View File

@ -2727,9 +2727,6 @@ provides a hook to control interactive evaluation through
@racket[load] (more precisely, the default @tech{load handler}) or
@racket[read-eval-print-loop].}
@;------------------------------------------------------------------------
@include-section["package.scrbl"]
@;------------------------------------------------------------------------
@include-section["block.scrbl"]

View File

@ -201,7 +201,7 @@ See also @racketmodname[scheme/runtime-config].
@compat[scheme/local racket/local]
@compat[scheme/match racket/match]
@compat[scheme/math racket/math]
@compat[scheme/mpair racket/mpair]
@compat[scheme/mpair compatibility/mlist]
@;------------------------------------------------------------------------
@section[#:tag "nest"]{@racketmodname[scheme/nest]}
@ -253,7 +253,7 @@ than a precise prose description:
@; ----------------------------------------
@compat[scheme/package racket/package]
@compat[scheme/package compatibility/package]
@compat[scheme/path racket/path]
@compat[scheme/port racket/port]

View File

@ -1,6 +1,6 @@
#lang racket/base
(require compatibility/mpair)
(require compatibility/mlist)
(define SIZE 10000)
(define (sequence start stop)

View File

@ -1,4 +1,4 @@
(require compatibility/mpair)
(require compatibility/mlist)
(define SIZE 10000)
(: sequence (Integer Integer -> (MListof Integer)))

View File

@ -3,7 +3,7 @@
(Section 'for)
(require compatibility/mpair
(require compatibility/mlist
"for-util.rkt")
(test-sequence [(0 1 2)] 3)

View File

@ -50,7 +50,7 @@ TR missed opt: pair.rkt 84:17 (set-mcdr! (ann (quote ()) (MListof Integer)) (ann
)
#lang typed/racket
(require compatibility/mpair)
(require compatibility/mlist)
;; car/cdr can be optimized if they are guaranteed to be applied only to
;; non-empty lists. otherwise, we miss a potential optimization

View File

@ -15,7 +15,7 @@
(only-in racket/private/pre-base new-apply-proc)
racket/promise racket/system
racket/function
compatibility/mpair
compatibility/mlist
racket/base
racket/set
racket/place