mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-20 11:40:18 +02:00
Code Activity

doc: Document default delimiter of string-join.

Browse source 
* 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 <ludo@gnu.org>
This commit is contained in:
Arun Isaac 2020-03-25 02:57:19 +05:30 • committed by Ludovic Courtès
parent 782a5af969
commit 67f5b451b0
2 changed files with 10 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/ref/api-data.texi
View file

@ -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

11
libguile/srfi-13.c
View file

@ -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"