From 67f5b451b06666cf174d013280b20b68e37f4536 Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Wed, 25 Mar 2020 02:57:19 +0530 Subject: [PATCH] doc: Document default delimiter of string-join. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * doc/ref/api-data.texi (String Constructors): Document default delimiter of the string-join function. * libguile/srfi-13.c (scm_string_join): Adjust docstring accordingly. Signed-off-by: Ludovic Courtès --- doc/ref/api-data.texi | 7 ++++--- libguile/srfi-13.c | 11 ++++++----- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi index 41d4f73c9..ed14b2298 100644 --- a/doc/ref/api-data.texi +++ b/doc/ref/api-data.texi @@ -3183,9 +3183,10 @@ produce the corresponding string element. The order in which @deffnx {C Function} scm_string_join (ls, delimiter, grammar) Append the string in the string list @var{ls}, using the string @var{delimiter} as a delimiter between the elements of @var{ls}. -@var{grammar} is a symbol which specifies how the delimiter is -placed between the strings, and defaults to the symbol -@code{infix}. +@var{delimiter} defaults to @w{@samp{ }}, that is, strings in @var{ls} +are appended with the space character in between them. @var{grammar} is +a symbol which specifies how the delimiter is placed between the +strings, and defaults to the symbol @code{infix}. @table @code @item infix diff --git a/libguile/srfi-13.c b/libguile/srfi-13.c index 97c372674..801591775 100644 --- a/libguile/srfi-13.c +++ b/libguile/srfi-13.c @@ -382,11 +382,12 @@ SCM_SYMBOL (scm_sym_prefix, "prefix"); SCM_DEFINE (scm_string_join, "string-join", 1, 2, 0, (SCM ls, SCM delimiter, SCM grammar), - "Append the string in the string list @var{ls}, using the string\n" - "@var{delimiter} as a delimiter between the elements of @var{ls}.\n" - "@var{grammar} is a symbol which specifies how the delimiter is\n" - "placed between the strings, and defaults to the symbol\n" - "@code{infix}.\n" + "Append the string in the string list @var{ls}, using the string\n" + "@var{delimiter} as a delimiter between the elements of @var{ls}.\n" + "@var{delimiter} defaults to @w{@samp{ }}, that is, strings in @var{ls}\n" + "are appended with the space character in between them. @var{grammar} is\n" + "a symbol which specifies how the delimiter is placed between the\n" + "strings, and defaults to the symbol @code{infix}.\n" "\n" "@table @code\n" "@item infix\n"