suzanne.soy/scribble-enhanced
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

scribble/manual: generalize deprecated

Browse Source 
original commit: 9dd9ffc2e2d63616a3f1790eff34a2cdafbc15de
This commit is contained in:
Matthew Flatt 2013-11-08 06:27:39 -07:00
parent 644ea52438
commit 098e9a37ff
3 changed files with 22 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl
View File

@ -689,14 +689,6 @@ per section, since the declaration applies to the entire section,
although overriding @racket[declare-exporting] forms can appear in although overriding @racket[declare-exporting] forms can appear in
sub-sections.} sub-sections.}
@defform/subs[(deprecated replacement additional-notes ...)
([replacement pre-content]
[additional-notes pre-content])]{
produces a warning for deprecated modules. Requires a replacement suggestion;
additional notes are welcome.
}
@defform*[[(defmodulelang one-or-multi maybe-sources option ... pre-flow ...) @defform*[[(defmodulelang one-or-multi maybe-sources option ... pre-flow ...)
(defmodulelang one-or-multi #:module-path module-path (defmodulelang one-or-multi #:module-path module-path
option ... pre-flow ...)]]{ option ... pre-flow ...)]]{
@ -1750,6 +1742,16 @@ Typesets the @racket[pre-flow]s as the content of
with @racket[filename] above it. If @racket[filename] is a string, it with @racket[filename] above it. If @racket[filename] is a string, it
is passed to @racket{filepath} to obtain an @racket[element].} is passed to @racket{filepath} to obtain an @racket[element].}
@defproc[(deprecated [#:what what content? "library"]
[replacement content?]
[additional-notes content?] ...)
block?]{
Produces an inset warning for deprecated libraries, functions, @|etc| (as
described by @racket[what]), where @racket[replacement] describes a
suitable replacement. The @racket[additional-notes] are included after the
initial deprecation message.}
@; ------------------------------------------------------------------------ @; ------------------------------------------------------------------------
@section[#:tag "index-entries"]{Index-Entry Descriptions} @section[#:tag "index-entries"]{Index-Entry Descriptions}

2
pkgs/scribble-pkgs/scribble-lib/scribble/HISTORY.txt
View File

@ -4,6 +4,8 @@ Add `--html-tree' option to for rendering to multi-page HTML
with nested directories for nested parts with nested directories for nested parts
For HTML rendering, merge generated `style' attributes within For HTML rendering, merge generated `style' attributes within
a single tag a single tag
scribble/manual: changed `deprecated` to a function, and
generalized it by adding an optional `#:what` argument
Older versions Older versions
See the "Racket core" release notes for a history of changes before See the "Racket core" release notes for a history of changes before

19
pkgs/scribble-pkgs/scribble-lib/scribble/private/manual-mod.rkt
View File

@ -29,15 +29,16 @@
;; @deprecated[Precontent]{Precontent ... } ;; @deprecated[Precontent]{Precontent ... }
;; produces a nested paragraph with a yellow NOTE label to warn readers of deprecated modules ;; produces a nested paragraph with a yellow NOTE label to warn readers of deprecated modules
(define-syntax-rule (define (deprecated #:what [what "library"]
(deprecated replacement-library additional-notes ...) replacement
;; ==> . additional-notes)
(nested #:style 'inset (apply nested #:style 'inset
(para (yellow (bold "NOTE:")) (yellow (bold "NOTE:"))
" This library is deprecated. Use " " This " what
replacement-library " is deprecated; use "
" instead. " replacement
additional-notes ...))) ", instead. "
additional-notes))
(define (yellow . content) (define (yellow . content)
(make-element (make-style #f (list (make-background-color-property "yellow"))) content)) (make-element (make-style #f (list (make-background-color-property "yellow"))) content))