]> git.eshelyaron.com Git - emacs.git/commitdiff
Amend doc of `mapconcat': it can take sequences, not merely strings.
authorAlan Mackenzie <acm@muc.de>
Mon, 7 Dec 2015 10:39:07 +0000 (10:39 +0000)
committerAlan Mackenzie <acm@muc.de>
Mon, 7 Dec 2015 10:39:07 +0000 (10:39 +0000)
* doc/lispref/functions.texi (Mapping Functions): Amend the doc of `mapconcat'
to say that SEPARATOR and the results from FUNCTION may be any character
sequences, not just strings.  Add an @xref to "Sequences Arrays Vectors".

doc/lispref/functions.texi

index 8835667b82db73db0901bdaacf703aa5f43f90f1..7cc041fa77e40b67b5437562de26b7b67b64c660 100644 (file)
@@ -861,15 +861,18 @@ into a list.  @code{mapc} always returns @var{sequence}.
 
 @defun mapconcat function sequence separator
 @code{mapconcat} applies @var{function} to each element of
-@var{sequence}: the results, which must be strings, are concatenated.
-Between each pair of result strings, @code{mapconcat} inserts the string
-@var{separator}.  Usually @var{separator} contains a space or comma or
-other suitable punctuation.
+@var{sequence}; the results, which must be sequences of characters
+(strings, vectors, or lists), are concatenated into a single string
+return value.  Between each pair of result sequences, @code{mapconcat}
+inserts the characters from @var{separator}, which also must be a
+string, or a vector or list of characters.  @xref{Sequences Arrays
+Vectors}.
 
 The argument @var{function} must be a function that can take one
-argument and return a string.  The argument @var{sequence} can be any
-kind of sequence except a char-table; that is, a list, a vector, a
-bool-vector, or a string.
+argument and returns a sequence of characters: a string, a vector, or
+a list.  The argument @var{sequence} can be any kind of sequence
+except a char-table; that is, a list, a vector, a bool-vector, or a
+string.
 
 @example
 @group