unofficial mirror of bug-guile@gnu.org 
 help / color / mirror / Atom feed
From: "Jan (janneke) Nieuwenhuizen" <janneke@gnu.org>
To: 43814@debbugs.gnu.org
Subject: bug#43814: [PATCH] Document write-line.
Date: Mon,  5 Oct 2020 15:52:59 +0200	[thread overview]
Message-ID: <20201005135259.4652-1-janneke@gnu.org> (raw)

* 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@gnu.org> | GNU LilyPond http://lilypond.org
Freelance IT http://JoyofSource.com | Avatar® http://AvatarAcademy.com






                 reply	other threads:[~2020-10-05 13:52 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=20201005135259.4652-1-janneke@gnu.org \
    --to=janneke@gnu.org \
    --cc=43814@debbugs.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).