Re: Doc patches outstanding

[Dr. Arne Babenhauserheide]

Hello Jean,

Jean Abou Samra <jean@abou-samra.fr> writes:
> Thank you for applying the first one nevertheless. I am attaching
> patch files for the other two, that should work better.

They are applied and pushed now — thank you, and thank you for your patience!

For the eval-when-example I wrote a small change to the wording, because
I found that the example actually runs in Guile 3.0.8, but retrieves the
runtime value of the date-time instead of the compile-time value.

Can you have a look? If it’s good to go from your side, I’d push it.

Subject: [PATCH] doc: More precise eval-when example description

* doc/ref/api-macros.texi: replace "will not work in a file" by "will
  cause problems in a file", because the example actually executes at
  runtime, so it works, but not as intended.
---
 doc/ref/api-macros.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/ref/api-macros.texi b/doc/ref/api-macros.texi
index a353719cb..ea4e85d3f 100644
--- a/doc/ref/api-macros.texi
+++ b/doc/ref/api-macros.texi
@@ -1239,7 +1239,7 @@ the procedure should be made available at expansion-time.
 For example, the following code tries to embed a compilation
 timestamp in the compiled bytecode using a macro that expands
 to the date as a string literal.  It will work at a REPL, but
-not in a file, as it cannot be byte-compiled:
+will cause problems in a file, as it cannot be byte-compiled:
 
 @example
 (use-modules (srfi srfi-19))

From 39fc107c76c48287b84abc2a51d6b3f778817560 Mon Sep 17 00:00:00 2001
From: Arne Babenhauserheide <arne_bab@web.de>
Date: Tue, 17 Jan 2023 07:17:56 +0100
Subject: [PATCH] doc: More precise eval-when example description

* doc/ref/api-macros.texi: replace "will not work in a file" by "will
  cause problems in a file", because the example actually executes at
  runtime, so it works, but not as intended.
---
 doc/ref/api-macros.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/ref/api-macros.texi b/doc/ref/api-macros.texi
index a353719cb..ea4e85d3f 100644
--- a/doc/ref/api-macros.texi
+++ b/doc/ref/api-macros.texi
@@ -1239,7 +1239,7 @@ the procedure should be made available at expansion-time.
 For example, the following code tries to embed a compilation
 timestamp in the compiled bytecode using a macro that expands
 to the date as a string literal.  It will work at a REPL, but
-not in a file, as it cannot be byte-compiled:
+will cause problems in a file, as it cannot be byte-compiled:
 
 @example
 (use-modules (srfi srfi-19))
-- 
2.38.1


Best wishes,
Arne

-- 
Unpolitisch sein
heißt politisch sein,
ohne es zu merken.
draketo.de

signature.asc
Description: PGP signature