From: Janneke Nieuwenhuizen <janneke@gnu.org>
To: 71684@debbugs.gnu.org
Cc: juli@incana.org, maxim.cournoyer@gmail.com, zimon.toutoune@gmail.com
Subject: bug#71684: [PATCH v3] doc: Document the peek and pk procedures.
Date: Mon, 14 Oct 2024 09:57:43 +0200 [thread overview]
Message-ID: <87ttdfce14.fsf@gnu.org> (raw)
In-Reply-To: <20240913200453.2965-1-juli@incana.org> (Juliana Sims via's message of "Fri, 13 Sep 2024 16:03:52 -0400")
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 <janneke@gnu.org> | GNU LilyPond https://LilyPond.org
Freelance IT https://www.JoyOfSource.com | Avatar® https://AvatarAcademy.com
next prev parent reply other threads:[~2024-10-14 7:57 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-06-20 18:54 bug#71684: [PATCH] doc: Document the peek and pk procedures Juliana Sims via Bug reports for GUILE, GNU's Ubiquitous Extension Language
2024-07-02 3:54 ` Maxim Cournoyer
2024-07-02 16:28 ` bug#71684: [PATCH v2] " Juliana Sims via Bug reports for GUILE, GNU's Ubiquitous Extension Language
2024-07-09 2:56 ` Maxim Cournoyer
2024-09-13 15:47 ` Maxim Cournoyer
2024-07-10 18:21 ` Simon Tournier
2024-07-10 19:48 ` Maxim Cournoyer
2024-07-11 8:59 ` Simon Tournier
2024-07-16 2:46 ` Juliana Sims via Bug reports for GUILE, GNU's Ubiquitous Extension Language
2024-07-23 15:24 ` bug#71684: [PATCH] " jgart via Bug reports for GUILE, GNU's Ubiquitous Extension Language
2024-09-13 15:42 ` bug#71684: [PATCH v2] " Maxim Cournoyer
2024-09-13 16:03 ` Simon Tournier
2024-09-13 20:03 ` bug#71684: [PATCH v3] " Juliana Sims via Bug reports for GUILE, GNU's Ubiquitous Extension Language
2024-10-14 7:57 ` Janneke Nieuwenhuizen [this message]
2024-10-14 12:53 ` bug#71684: [PATCH v4] " Juliana Sims via Bug reports for GUILE, GNU's Ubiquitous Extension Language
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87ttdfce14.fsf@gnu.org \
--to=janneke@gnu.org \
--cc=71684@debbugs.gnu.org \
--cc=juli@incana.org \
--cc=maxim.cournoyer@gmail.com \
--cc=zimon.toutoune@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).