commit bebefaa45c5bfbd7975e806433b034d6794710c0
parent 06fcc23c24c17b7284350b2696a0fb5e65f7dbd2
Author: William J. Bowman <wjb@williamjbowman.com>
Date: Sun, 24 Nov 2013 22:27:29 -0500
* Updated manual to explain #:escape-id parameter to comment-reader
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl
* Changed parameter name to #:escape-id.
pkgs/scribble-pkgs/scribble-lib/scribble/comment-reader.rkt
original commit: 9907165af8009585ab5e0f4427d68acbdeadc0a0
Diffstat:
2 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl
@@ -416,6 +416,26 @@ because the @"@"-reader would drop comments within the
@racket[racketblock] before giving
@racketmodname[scribble/comment-reader] a chance to convert them.
+@racketmodname[scribble/comment-reader] uses @racket[unsyntax] to
+typeset comments. When using @racketmodname[scribble/comment-reader]
+with, for instance, @racket[RACKETBLOCK], which specifies
+@racket[UNSYNTAX] as @racket[escape-id], this causes problems. You can
+pass a new @racket[escape-id] for
+@racketmodname[scribble/comment-reader] by using @racket[#:escape-id]:
+
+@verbatim[#:indent 2]|{
+ @#reader scribble/comment-reader #:escape-id UNSYNTAX
+ (RACKETBLOCK
+ (define-syntax (m syn)
+ (syntax-case syn ()
+ [(_ x)
+ ;; Well this was silly
+ #`(#,x)]))
+ )
+}|
+
+
+
@; ------------------------------------------------------------------------
@subsection{Code Fonts and Styles}
diff --git a/pkgs/scribble-pkgs/scribble-lib/scribble/comment-reader.rkt b/pkgs/scribble-pkgs/scribble-lib/scribble/comment-reader.rkt
@@ -18,7 +18,7 @@
(define (read-unsyntaxer port)
(let-values ([(l c p) (port-next-location port)])
- (if (eq? (read port) '#:unsyntax)
+ (if (eq? (read port) '#:escape-id)
(read port)
(begin
(set-port-next-location! port l c p)