doc: document reset

sorawee · Jan 18, 2024 · e57f828 · e57f828
1 parent 52cd12b
commit e57f828
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/scribblings/pretty-expressive.scrbl b/scribblings/pretty-expressive.scrbl
@@ -363,6 +363,21 @@ both @tech{doc} construction and @racket[pretty-print] would be inefficient.
   ]
 }
 
+@defproc[(reset [d doc?]) doc?]{
+  Resets the indentation level to 0 when rendering the @tech{doc} @racket[d].
+  This is especially useful for formatting multi-line strings and multi-line comments.
+
+  @examples[#:eval evaluator
+    (define subd (reset (<> (text "#<<EOF") nl
+                            (text "Zelda") nl
+                            (text "Baba is you") nl
+                            (text "EOF"))))
+    (pretty-print (<> (text "when 1 = 2:")
+                      (nest 4 (<> nl (text "print ") subd))))
+  ]
+}
+
+
 @defthing[fail doc?]{
   Constructs a @tech{doc} that fails to render.
   This doc interacts with @racket[alt]: failing branches are pruned away.