* bug#43814: [PATCH] Document write-line.
@ 2020-10-05 13:52 Jan (janneke) Nieuwenhuizen
2024-10-25 18:22 ` lloda
0 siblings, 1 reply; 2+ messages in thread
From: Jan (janneke) Nieuwenhuizen @ 2020-10-05 13:52 UTC (permalink / raw)
To: 43814
* 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
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2024-10-25 18:22 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2020-10-05 13:52 bug#43814: [PATCH] Document write-line Jan (janneke) Nieuwenhuizen
2024-10-25 18:22 ` lloda
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).