mirror of
https://git.savannah.gnu.org/git/guile.git
synced 2025-05-20 19:50:24 +02:00
doc: Document default delimiter of string-join.
* 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:
parent
782a5af969
commit
67f5b451b0
2 changed files with 10 additions and 8 deletions
|
@ -3183,9 +3183,10 @@ produce the corresponding string element. The order in which
|
||||||
@deffnx {C Function} scm_string_join (ls, delimiter, grammar)
|
@deffnx {C Function} scm_string_join (ls, delimiter, grammar)
|
||||||
Append the string in the string list @var{ls}, using the string
|
Append the string in the string list @var{ls}, using the string
|
||||||
@var{delimiter} as a delimiter between the elements of @var{ls}.
|
@var{delimiter} as a delimiter between the elements of @var{ls}.
|
||||||
@var{grammar} is a symbol which specifies how the delimiter is
|
@var{delimiter} defaults to @w{@samp{ }}, that is, strings in @var{ls}
|
||||||
placed between the strings, and defaults to the symbol
|
are appended with the space character in between them. @var{grammar} is
|
||||||
@code{infix}.
|
a symbol which specifies how the delimiter is placed between the
|
||||||
|
strings, and defaults to the symbol @code{infix}.
|
||||||
|
|
||||||
@table @code
|
@table @code
|
||||||
@item infix
|
@item infix
|
||||||
|
|
|
@ -384,9 +384,10 @@ SCM_DEFINE (scm_string_join, "string-join", 1, 2, 0,
|
||||||
(SCM ls, SCM delimiter, SCM grammar),
|
(SCM ls, SCM delimiter, SCM grammar),
|
||||||
"Append the string in the string list @var{ls}, using the string\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} as a delimiter between the elements of @var{ls}.\n"
|
||||||
"@var{grammar} is a symbol which specifies how the delimiter is\n"
|
"@var{delimiter} defaults to @w{@samp{ }}, that is, strings in @var{ls}\n"
|
||||||
"placed between the strings, and defaults to the symbol\n"
|
"are appended with the space character in between them. @var{grammar} is\n"
|
||||||
"@code{infix}.\n"
|
"a symbol which specifies how the delimiter is placed between the\n"
|
||||||
|
"strings, and defaults to the symbol @code{infix}.\n"
|
||||||
"\n"
|
"\n"
|
||||||
"@table @code\n"
|
"@table @code\n"
|
||||||
"@item infix\n"
|
"@item infix\n"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue