unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: "Dr. Arne Babenhauserheide" <arne_bab@web.de>
To: Jean Abou Samra <jean@abou-samra.fr>
Cc: guile-devel@gnu.org
Subject: Re: Doc patches outstanding
Date: Tue, 17 Jan 2023 07:21:04 +0100	[thread overview]
Message-ID: <87r0vtoevp.fsf@web.de> (raw)
In-Reply-To: <c7bc8018-8e23-aacf-afb9-8f783408182e@abou-samra.fr>


[-- Attachment #1.1: Type: text/plain, Size: 1503 bytes --]

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))


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-doc-More-precise-eval-when-example-description.patch --]
[-- Type: text/x-patch, Size: 1107 bytes --]

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


[-- Attachment #1.3: Type: text/plain, Size: 105 bytes --]



Best wishes,
Arne

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 1125 bytes --]

  parent reply	other threads:[~2023-01-17  6:21 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-07 18:52 Doc patches outstanding Jean Abou Samra
2022-12-11  2:05 ` Dr. Arne Babenhauserheide
2022-12-11 11:30   ` Jean Abou Samra
2023-01-10 15:51     ` Jean Abou Samra
2023-01-10 17:50       ` Dr. Arne Babenhauserheide
2023-01-17  6:21     ` Dr. Arne Babenhauserheide [this message]
2023-01-17 12:37       ` Jean Abou Samra
2023-01-17 19:02         ` Dr. Arne Babenhauserheide

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=87r0vtoevp.fsf@web.de \
    --to=arne_bab@web.de \
    --cc=guile-devel@gnu.org \
    --cc=jean@abou-samra.fr \
    /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).