* [PATCH] Docs: Remove mentions of unimplemented features, fix example
@ 2020-12-02 12:13 Antoine Kalmbach
0 siblings, 0 replies; only message in thread
From: Antoine Kalmbach @ 2020-12-02 12:13 UTC (permalink / raw)
To: guile-devel; +Cc: Antoine Kalmbach
* 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)
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2020-12-02 12:13 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-12-02 12:13 [PATCH] Docs: Remove mentions of unimplemented features, fix example Antoine Kalmbach
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).