commit e92229f4811637250b2a311585e8cea99bebaa9b
parent f6460dac5e0b3ed44d1f46b959af1d6231eed4e1
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Mon, 7 Mar 2016 19:06:53 -0700
doc: explain indentation and workaround for `racketresultblock`
Diffstat:
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/scribble-doc/scribblings/scribble/manual.scrbl b/scribble-doc/scribblings/scribble/manual.scrbl
@@ -342,7 +342,15 @@ without insetting the code via @racket[nested].}
)]{
Like @racket[racketblock], etc., but colors the typeset text as a
-result (i.e., a single color with no hyperlinks) instead of code.}
+result (i.e., a single color with no hyperlinks) instead of code.
+
+Unlike @racket[racketblock], @racket[racketresultblock] and
+@racket[RACKETRESULTBLOCK] implement indentation by adding an
+@racket[(hspace 2)] to the start of each line, instead of using
+@racket[nested] with the @racket['code-inset] style. To get formatting
+more like @racket[racketblock] and @racket[racketinput], use
+@racket[(nested #:style 'code-inset (racketresultblock0 datum ...))]
+instead of @racket[(racketresultblock datum ...)].}
@deftogether[(
@defform[(racketinput maybe-escape datum ...)]