From: Stephen Berman <stephen.berman@gmx.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: a.lloyd.flanagan@gmail.com, 24740@debbugs.gnu.org,
Stephen Berman <stephen.berman@gmx.net>
Subject: bug#24740: 26.0.50; Bad signature for alist-get in elisp manual
Date: Thu, 20 Oct 2016 10:10:06 +0200 [thread overview]
Message-ID: <87shrrzbj5.fsf@rub.de> (raw)
In-Reply-To: <83shrrtq8f.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 20 Oct 2016 10:49:04 +0300")
On Thu, 20 Oct 2016 10:49:04 +0300 Eli Zaretskii <eliz@gnu.org> wrote:
>> From: Stephen Berman <stephen.berman@gmx.net>
>> Cc: eliz@gnu.org, a.lloyd.flanagan@gmail.com
>> Date: Thu, 20 Oct 2016 01:39:15 +0200
>>
>> > -@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?
>
> @var is not only for formal arguments, it's for any symbol which
> stands for something else. That is why @var is also used in the cons
> cell description; it is not because KEY and VALUE happen to appear in
> the function argument list.
Ok, thanks for the clarification. I think the distinction would be made
clearer if the definite article were omitted: "it returns just VALUE",
as it is in the subsequent sentence; the definite article makes it sound
to me more like a use than a mention.
Steve Berman
prev parent reply other threads:[~2016-10-20 8:10 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-19 17:01 bug#24740: 26.0.50; Bad signature for alist-get in elisp manual A. Lloyd Flanagan
2016-10-19 18:12 ` Eli Zaretskii
2016-10-19 23:39 ` Stephen Berman
2016-10-20 1:00 ` A. Lloyd Flanagan
2016-10-20 7:49 ` Eli Zaretskii
2016-10-20 8:10 ` Stephen Berman [this message]
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=87shrrzbj5.fsf@rub.de \
--to=stephen.berman@gmx.net \
--cc=24740@debbugs.gnu.org \
--cc=a.lloyd.flanagan@gmail.com \
--cc=eliz@gnu.org \
/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.