[Guile-commits] 01/03: Document write-line.

[Jan Nieuwenhuizen]

janneke pushed a commit to branch master
in repository guile.

commit 3db293a71dc93776ee262063d40b2e8304c49ac6
Author: Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
AuthorDate: Mon Oct 5 15:25:52 2020 +0200

    Document write-line.
    
    * 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 777f282..87d4af4 100644
--- a/doc/ref/api-io.texi
+++ b/doc/ref/api-io.texi
@@ -834,6 +834,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 4a0b209..9d41712 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"