GNU bug report logs - #43814
[PATCH] Document write-line.

Message received at submit <at> debbugs.gnu.org:

Received: (at submit) by debbugs.gnu.org; 5 Oct 2020 13:53:08 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Mon Oct 05 09:53:08 2020
Received: from localhost ([127.0.0.1]:48377 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1kPQvM-0004a1-70
	for submit <at> debbugs.gnu.org; Mon, 05 Oct 2020 09:53:08 -0400
Received: from lists.gnu.org ([209.51.188.17]:35630)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <janneke@HIDDEN>) id 1kPQvH-0004Zq-G6
 for submit <at> debbugs.gnu.org; Mon, 05 Oct 2020 09:53:06 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10]:53228)
 by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <janneke@HIDDEN>) id 1kPQvH-0004Ou-6b
 for bug-guile@HIDDEN; Mon, 05 Oct 2020 09:53:03 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e]:59057)
 by eggs.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <janneke@HIDDEN>)
 id 1kPQvG-0008Md-Rp; Mon, 05 Oct 2020 09:53:02 -0400
Received: from [2001:980:1b4f:1:42d2:832d:bb59:862] (port=36516
 helo=dundal.fritz.box) by fencepost.gnu.org with esmtpa (Exim 4.82)
 (envelope-from <janneke@HIDDEN>)
 id 1kPQvG-0001Xm-9p; Mon, 05 Oct 2020 09:53:02 -0400
From: "Jan (janneke) Nieuwenhuizen" <janneke@HIDDEN>
To: bug-guile@HIDDEN
Subject: [PATCH] Document write-line.
Date: Mon,  5 Oct 2020 15:52:59 +0200
Message-Id: <20201005135259.4652-1-janneke@HIDDEN>
X-Mailer: git-send-email 2.28.0
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

* libguile/rdelim.c (SCM_DEFINE): Use "procedure" rather than
"function".
* doc/ref/api-io.texi (Line/Delimited): Use it to document 'write-line'.
---
 doc/ref/api-io.texi | 11 +++++++++++
 libguile/rdelim.c   |  2 +-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/doc/ref/api-io.texi b/doc/ref/api-io.texi
index ecbd35585a..a1781dfd6a 100644
--- a/doc/ref/api-io.texi
+++ b/doc/ref/api-io.texi
@@ -829,6 +829,17 @@ delimiter may be either a newline or the @var{eof-object}; if
 @code{(#<eof> . #<eof>)}.
 @end deffn
 
+@deffn {Scheme Procedure} write-line obj [port]
+@deffnx {C Function} scm_write_line (obj, port)
+Display @var{obj} and a newline character to @var{port}.  If
+@var{port} is not specified, @code{(current-output-port)} is
+used.  This procedure is equivalent to:
+@lisp
+(display obj [port])
+(newline [port])
+@end lisp
+@end deffn
+
 @node Default Ports
 @subsection Default Ports for Input, Output and Errors
 @cindex Default ports
diff --git a/libguile/rdelim.c b/libguile/rdelim.c
index 4a0b20954e..9d41712dd1 100644
--- a/libguile/rdelim.c
+++ b/libguile/rdelim.c
@@ -189,7 +189,7 @@ SCM_DEFINE (scm_write_line, "write-line", 1, 1, 0,
             (SCM obj, SCM port),
 	    "Display @var{obj} and a newline character to @var{port}.  If\n"
 	    "@var{port} is not specified, @code{(current-output-port)} is\n"
-	    "used.  This function is equivalent to:\n"
+	    "used.  This procedure is equivalent to:\n"
 	    "@lisp\n"
 	    "(display obj [port])\n"
 	    "(newline [port])\n"
-- 
Jan Nieuwenhuizen <janneke@HIDDEN> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com