unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: Antoine Kalmbach <ane@iki.fi>
To: guile-devel@gnu.org
Cc: Antoine Kalmbach <ane@iki.fi>
Subject: [PATCH] Docs: Remove mentions of unimplemented features, fix example
Date: Wed,  2 Dec 2020 14:13:49 +0200	[thread overview]
Message-ID: <20201202121349.85517-1-ane@iki.fi> (raw)

* 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	other threads:[~2020-12-02 12:13 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20201202121349.85517-1-ane@iki.fi \
    --to=ane@iki.fi \
    --cc=guile-devel@gnu.org \
    /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).