GNU bug report logs - #24740
26.0.50; Bad signature for alist-get in elisp manual

Previous Next

Full log

View this message in rfc822 format

From: "A. Lloyd Flanagan" <a.lloyd.flanagan <at> gmail.com>
To: Stephen Berman <stephen.berman <at> gmx.net>, 24740 <at> debbugs.gnu.org
Cc: eliz <at> gnu.org
Subject: bug#24740: 26.0.50; Bad signature for alist-get in elisp manual
Date: Thu, 20 Oct 2016 01:00:15 +0000

[Message part 1 (text/plain, inline)]

Yes, good catch.

On Wed, Oct 19, 2016, 7:39 PM Stephen Berman <stephen.berman <at> gmx.net> wrote:

> On Wed, 19 Oct 2016 21:12:00 +0300 Eli Zaretskii <eliz <at> gnu.org> wrote:
>
> >> From: a.lloyd.flanagan <at> gmail.com (A. Lloyd Flanagan)
> >> Date: Wed, 19 Oct 2016 13:01:51 -0400
> >>
> >> In the elisp manual, section "Association Lists", the function alist-get
> >> is shown with the signature:
> >>
> >> Function: alist-get key value &optional default remove
> >>
> >> but it should be
> >>
> >> Function: alist-get key alist &optional default remove
> >
> > Thanks, fixed on the emacs-25 branch.
>
>
> > -@defun alist-get key value &optional default remove
> > +@defun alist-get key alist &optional default remove
> >  This function is like @code{assq}, but instead of returning the entire
> > -association for @var{key}, @code{(@var{key} . @var{value})}, it
> > -returns just the @var{value}.  If @var{key} is not found in
> > -@var{alist} it returns @var{default}.
> > +association for @var{key} in @var{alist},
> > +@w{@code{(@var{key} . @var{value})}}, it returns just the @var{value}.
>                                                              ^^^^^^^^^^^
> > +If @var{key} is not found in @var{alist}, it returns @var{default}.
>
> Shouldn't the text be "it returns just the value", i.e. without the
> markup, since `value' is no longer a formal argument of the function
> signature?
>
> Steve Berman
>
-- 
"They have computers, and they may have other weapons of mass destruction."
-- Janet Reno

[Message part 2 (text/html, inline)]

Previous Next

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