[Top][All Lists]

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

bug#43814: [PATCH] Document write-line.

From: Jan (janneke) Nieuwenhuizen
Subject: bug#43814: [PATCH] Document write-line.
Date: Mon, 5 Oct 2020 15:52:59 +0200

* libguile/rdelim.c (SCM_DEFINE): Use "procedure" rather than
* 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}; 
 @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:
+(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"
            "(display obj [port])\n"
            "(newline [port])\n"
Jan Nieuwenhuizen <janneke@gnu.org> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | AvatarĀ® http://AvatarAcademy.com

reply via email to

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