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: Stephen Berman <stephen.berman <at> gmx.net>
To: 24740 <at> debbugs.gnu.org
Cc: a.lloyd.flanagan <at> gmail.com, eliz <at> gnu.org
Subject: bug#24740: 26.0.50; Bad signature for alist-get in elisp manual
Date: Thu, 20 Oct 2016 01:39:15 +0200

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

Previous Next

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