guile-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Docs: Remove mentions of unimplemented features, fix example


From: Antoine Kalmbach
Subject: [PATCH] Docs: Remove mentions of unimplemented features, fix example
Date: Wed, 2 Dec 2020 14:13:49 +0200

* doc/ref/api-coverage.texi (Code Coverage): #:modules is not
  supported... never seems to have been supported?
  (example): close port, not file.
---
FSF assignment not done yet, but this is a small change.

was #:modules ever implemented?  git history doesn't seem to indicate so.

 doc/ref/api-coverage.texi | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/ref/api-coverage.texi b/doc/ref/api-coverage.texi
index 5081d343b..0396cf60f 100644
--- a/doc/ref/api-coverage.texi
+++ b/doc/ref/api-coverage.texi
@@ -25,12 +25,11 @@ 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 currently loaded modules.
 
 The generated data can be fed to LCOV's @command{genhtml} command to produce an
 HTML report, which aids coverage data visualization.
@@ -49,7 +48,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.24.3 (Apple Git-128)




reply via email to

[Prev in Thread] Current Thread [Next in Thread]