diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/manual.scrbl index 381164df..16623a6c 100644 --- 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}