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

Previous Next

Package: guile;

Reported by: Antoine Kalmbach <ane <at> iki.fi>

Date: Wed, 24 Aug 2022 09:10:01 UTC

Severity: normal

Tags: patch

Done: Ludovic Courtès <ludo <at> gnu.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Antoine Kalmbach <ane <at> iki.fi>
To: 57377 <at> debbugs.gnu.org
Subject: bug#57377: [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




This bug report was last modified 2 years and 258 days ago.

Previous Next


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