GNU bug report logs - #57377
[PATCH] api-coverage.texi: fix example, remove mentions of unimplemented features

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 57377 in the body.
You can then email your comments to 57377 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Antoine Kalmbach <ane <at> iki.fi>
To: bug-guile <at> gnu.org
Subject: [PATCH] api-coverage.texi: fix example, remove mentions of
 unimplemented features
Date: Wed, 24 Aug 2022 12:09:00 +0300

* doc/ref/api-coverage.texi (Code Coverage): #:modules is not
  supported... never seems to have been supported?
  (example): close port, not file.
---
 doc/ref/api-coverage.texi | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/ref/api-coverage.texi b/doc/ref/api-coverage.texi
index 5081d343b..61ac4abf1 100644
--- a/doc/ref/api-coverage.texi
+++ b/doc/ref/api-coverage.texi
@@ -25,12 +25,12 @@ Return @code{#t} if @var{obj} is a @dfn{coverage data} object as returned by
 @code{with-code-coverage}.
 @end deffn
 
-@deffn {Scheme Procedure} coverage-data->lcov data port #:key modules
+@deffn {Scheme Procedure} coverage-data->lcov data port
 Traverse code coverage information @var{data}, as obtained with
 @code{with-code-coverage}, and write coverage information to port in the
 @code{.info} format used by @url{http://ltp.sourceforge.net/coverage/lcov.php,
-LCOV}.  The report will include all of @var{modules} (or, by default, all the
-currently loaded modules) even if their code was not executed.
+LCOV}.  The report will include all the modules loaded at the time
+coverage data was gathered, even if their code was not executed.
 
 The generated data can be fed to LCOV's @command{genhtml} command to produce an
 HTML report, which aids coverage data visualization.
@@ -49,7 +49,7 @@ Here's an example use:
   (lambda (data result)
     (let ((port (open-output-file "lcov.info")))
       (coverage-data->lcov data port)
-      (close file))))
+      (close port))))
 @end example
 
 In addition, the module provides low-level procedures that would make it
-- 
2.35.1

Message #10 received at 57377-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Antoine Kalmbach <ane <at> iki.fi>
Cc: 57377-done <at> debbugs.gnu.org
Subject: Re: bug#57377: [PATCH] api-coverage.texi: fix example, remove
 mentions of unimplemented features
Date: Sat, 01 Oct 2022 15:57:46 +0200

Hi Antoine,

Antoine Kalmbach <ane <at> iki.fi> skribis:

> * doc/ref/api-coverage.texi (Code Coverage): #:modules is not
>   supported... never seems to have been supported?
>   (example): close port, not file.

In commit 4456245753ff925cafd3e72d130761b6f1c2c419, Jessica Talon added
support for #:modules.

I applied the fix for the typo you found in the example, though.

Thank you!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.