diff options
| author | Arun Isaac <arunisaac@systemreboot.net> | 2020-03-25 02:57:19 +0530 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2020-06-18 00:30:30 +0200 |
| commit | 67f5b451b06666cf174d013280b20b68e37f4536 (patch) | |
| tree | f8892d6454307d5db2672f2bbdac375a07d107f9 /doc | |
| parent | 782a5af969b65bbcd00a51877dd28b7ba8b34fd1 (diff) | |
| download | guile-67f5b451b06666cf174d013280b20b68e37f4536.tar.gz | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ref/api-data.texi | 7 |
1 files changed, 4 insertions, 3 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 |