suzanne.soy/hyper-literate
1
0
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

add a form to declare a module/library deprecated

Browse Source 
original commit: 9ef66b80eac46a18fd200cef2f8c084ca7f6a0b7
This commit is contained in:
Matthias Felleisen 2012-04-28 13:17:47 -04:00
parent 876b221b05
commit c971d20757
2 changed files with 38 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
collects/scribble/private/manual-mod.rkt
View File

@ -15,6 +15,28 @@
defmodule*/no-declare defmodulelang*/no-declare defmodulereader*/no-declare
declare-exporting)
;; ---------------------------------------------------------------------------------------------------
(provide deprecated)
(require (only-in scribble/core make-style make-background-color-property)
(only-in scribble/base para nested))
;; @deprecated[Precontent]{Precontent ... }
;; produces a nested paragraph with a yellow NOTE label to warn readers of deprecated modules
(define-syntax-rule
(deprecated replacement-library additional-notes ...)
;; ==>
(nested #:style 'inset
(para (yellow (bold "NOTE:"))
" This library is deprecated. Use "
replacement-library
" instead. "
additional-notes ...)))
(define (yellow . content)
(make-element (make-style #f (list (make-background-color-property "yellow"))) content))
;; ---------------------------------------------------------------------------------------------------
(define spacer (hspace 1))
(define-syntax defmodule*/no-declare
@ -62,20 +84,20 @@
(define-syntax defmodulelang*
(syntax-rules ()
[(_ (name ...) #:module-paths (modpath ...)
#:use-sources (pname ...)
. content)
#:use-sources (pname ...)
. content)
(begin (declare-exporting modpath ... #:use-sources (pname ...))
(defmodulelang*/no-declare (name ...)
#:module-paths (modpath ...)
. content))]
#:module-paths (modpath ...)
. content))]
[(_ (name ...) #:module-paths (modpath ...) . content)
(defmodulelang* (name ...)
#:module-paths (modpath ...)
#:use-sources () . content)]
#:module-paths (modpath ...)
#:use-sources () . content)]
[(_ (name ...) #:use-sources (pname ...) . content)
(defmodulelang* ((racketmodname name) ...)
#:module-paths (name ...)
#:use-sources (pname ...) . content)]
#:module-paths (name ...)
#:use-sources (pname ...) . content)]
[(_ (name ...) . content)
(defmodulelang* (name ...) #:use-sources () . content)]))

8
collects/scribblings/scribble/manual.scrbl
View File

@ -660,6 +660,14 @@ per section, since the declaration applies to the entire section,
although overriding @racket[declare-exporting] forms can appear in
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.
}
@; ------------------------------------------------------------------------
@section[#:tag "doc-forms"]{Documenting Forms, Functions, Structure Types, and Values}