From: Eli Zaretskii <eliz@gnu.org>
To: Alan Mackenzie <acm@muc.de>
Cc: 22101@debbugs.gnu.org
Subject: bug#22101: Emacs-25: inaccuracy in documentation of `mapconcat' in .../lispref/functions.texi
Date: Sun, 06 Dec 2015 18:04:46 +0200 [thread overview]
Message-ID: <83vb8bef6p.fsf@gnu.org> (raw)
In-Reply-To: <20151206102622.GA2113@acm.fritz.box>
> Date: Sun, 6 Dec 2015 10:26:22 +0000
> From: Alan Mackenzie <acm@muc.de>
>
> In the elisp manual, mapconcat is described thusly:
>
> `mapconcat' applies FUNCTION to each element of SEQUENCE: the
> results, which must be strings, are concatenated. Between each
> ^^^^^^^^^^^^^^^^^^^^^
> pair of result strings, `mapconcat' inserts the string SEPARATOR.
> ^^^^^^^^^^
> Usually SEPARATOR contains a space or comma or other suitable
> punctuation.
>
> The results returned by FUNCTION need not be strings; they may be of any
> sequence type acceptable to `concat'. The same applies to SEPARATOR.
Indeed.
> Either the code or the documentation is wrong. I strongly believe it's
> the documentation.
Yes, I agree.
> Here's a patch to fix it. I will apply this patch to the emacs-25 branch
> soon, if I don't hear any objections.
>
>
>
> diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
> index 8835667..1b949f2 100644
> --- a/doc/lispref/functions.texi
> +++ b/doc/lispref/functions.texi
> @@ -861,13 +861,15 @@ Mapping Functions
>
> @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{sequence}: the results, which must be sequences, are
> +concatenated. These result sequences are usually strings, but may
> +also be lists of numbers or vectors of numbers. Between each pair of
> +result sequences, @code{mapconcat} inserts the sequence
> @var{separator}. Usually @var{separator} contains a space or comma or
> other suitable punctuation.
IMO, this errs on the other side: it seems to allow sequences that
will be rejected by mapconcat or by concat that it calls. I suggest
the following alternative wording:
@code{mapconcat} applies @var{function} to each element of
@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.
The argument @var{function} must be a function that can take one
argument and return 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.
WDYT?
next prev parent reply other threads:[~2015-12-06 16:04 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-12-06 10:26 bug#22101: Emacs-25: inaccuracy in documentation of `mapconcat' in .../lispref/functions.texi Alan Mackenzie
2015-12-06 16:04 ` Eli Zaretskii [this message]
2015-12-06 21:41 ` Alan Mackenzie
2015-12-07 10:54 ` Alan Mackenzie
2015-12-07 15:51 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83vb8bef6p.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=22101@debbugs.gnu.org \
--cc=acm@muc.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.