Juliana Sims via Bug reports for GUILE, GNU's Ubiquitous Extension Language
writes:
> * doc/ref/api-debug.texi: Document the peek and pk procedures.
> ---
>
> Hey y'all,
>
> Thanks for the feedback! I've incorporated both suggestions in this new
> patch.
[..]
> +@lisp
> +(define fire 'burns)
> +
> +(pk fire)
> +@result{}
> +
> +;;; (burns)
> +burns
> +@end
These should read
@end lisp
--8<---------------cut here---------------start------------->8---
diff --git a/doc/ref/api-debug.texi b/doc/ref/api-debug.texi
index df109d390..ca5175b35 100644
--- a/doc/ref/api-debug.texi
+++ b/doc/ref/api-debug.texi
@@ -58,7 +58,7 @@ Here is a basic example:
;;; (burns)
burns
-@end
+@end lisp
Here is an example of inspecting a value in the midst of code flow:
@@ -74,7 +74,7 @@ Here is an example of inspecting a value in the midst of code
flow:
;;; ("4")
("1" "2" "3" "4")
-@end
+@end lisp
A common technique when using @code{pk} is to label values with symbols
to keep track of where they're coming from. There's no reason these
@@ -90,7 +90,7 @@ slightly more complex example demonstrating that pattern:
;;; (arg-to-identity 42)
42
-@end
+@end lisp
@code{pk} has one small quirk of note. Currently, it only returns the
first value returned from any multi-value returns. So for example:
@@ -101,7 +101,7 @@ first value returned from any multi-value returns. So for
example:
;;; (vals 1)
1
-@end
+@end lisp
The way to get around this limitation is to bind such multi-value
returns then inspect the results. Still, @code{pk} can only return a
@@ -117,7 +117,7 @@ single value:
;;; (vals 1 2 3)
3
-@end
+@end lisp
@node Evaluation Model
--8<---------------cut here---------------end--------------->8---
Greetings,
Janneke
--
Janneke Nieuwenhuizen <jann...@gnu.org> | GNU LilyPond https://LilyPond.org
Freelance IT https://www.JoyOfSource.com | Avatar® https://AvatarAcademy.com
