bkyk8rc3zvpnsf5inmcqq4n3k98cv6hj-my-site-hyper-literate-git.test.suzanne.soy-0.0.1

commit 6d992d7a2f068a9823930c90631267eb5268e77e
parent a93ee701fd66f7b3119e25744aedc0954dc8545b
Author: Matthew Flatt <mflatt@racket-lang.org>
Date:   Sun,  8 Dec 2013 07:46:29 -0700

scribble/comment-reader doc tweaks

original commit: ec30c8c2545e995770fe6d35896b91d08bddec74

Diffstat:
M
pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl
 | 
23
++++++++++++++++-------

1 file changed, 16 insertions(+), 7 deletions(-)
diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl
@@ -416,25 +416,34 @@ 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
+The implementation of @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]:
+with, for instance, @racket[RACKETBLOCK], @racket[unsyntax] does not escape,
+since @racket[RACKETBLOCK] uses @racket[UNSYNTAX] as its escape form. You can
+declare an escape identifier for
+@racketmodname[scribble/comment-reader] with @racket[#:escape-id]. For example,
 
 @verbatim[#:indent 2]|{
   @#reader scribble/comment-reader #:escape-id UNSYNTAX
    (RACKETBLOCK
-     (define-syntax (m syn)
-       (syntax-case syn ()
+     (define-syntax (m stx)
+       (syntax-case stx ()
          [(_ x)
           ;; Well this was silly
           #`(#,x)]))
    )
 }|
 
+generates
 
+  @#reader scribble/comment-reader #:escape-id UNSYNTAX
+   (RACKETBLOCK
+     (define-syntax (m stx)
+       (syntax-case stx ()
+         [(_ x)
+          ;; Well this was silly
+          #`(#,x)]))
+   )
 
 @; ------------------------------------------------------------------------
 @subsection{Code Fonts and Styles}