GNU bug report logs - #22101
Emacs-25: inaccuracy in documentation of `mapconcat' in .../lispref/functions.texi

Previous Next

Full log

Message #19 received at 22101 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Alan Mackenzie <acm <at> muc.de>
Cc: 22101 <at> debbugs.gnu.org
Subject: Re: bug#22101: Emacs-25: inaccuracy in documentation of
 `mapconcat'	in	.../lispref/functions.texi
Date: Mon, 07 Dec 2015 17:51:24 +0200

> Date: Mon, 7 Dec 2015 10:54:58 +0000
> Cc: 22101-done <at> debbugs.gnu.org
> From: Alan Mackenzie <acm <at> muc.de>
> 
> > 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?
> 
> I think it's good.  I have just taken the liberty of committing your
> version

Such an impatience...

Did you forget to push?

> with two changes: I have added @xref{Sequences Arrays Vectors}
> at the end of the first paragraph.

It should be way up in the text preceding this @defun, because the
section talks about sequences much earlier, and it makes no sense to
have the cross-reference so late in the text.

Thanks.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.