From: "Mattias Engdegård" <mattiase@acm.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 35206-done@debbugs.gnu.org
Subject: bug#35206: [PATCH] Misleading `list-get' argument description
Date: Tue, 9 Apr 2019 16:59:48 +0200 [thread overview]
Message-ID: <948BCACD-D6CE-46AD-A31A-82272AB1A077@acm.org> (raw)
In-Reply-To: <83a7gz6y1z.fsf@gnu.org>
9 apr. 2019 kl. 16.41 skrev Eli Zaretskii <eliz@gnu.org>:
>
> Find an element of ALIST whose `car' equals KEY and return its `cdr'.
> ...
> Equality with KEY is tested by TESTFN, defaulting to `eq'.
Thank you, I pushed that change (except that I used "the first element" instead of "an element" for precision).
> IMO, this isn't about assuming knowledge, this is about being as
> explicit as reasonably possible about what the function does.
> (Strictly speaking, both your suggestion and mine still assume some
> knowledge about alists, because we never explain what is an alist, nor
> what is an "element" of an alist.)
That's all right -- I was mainly concerned with the quite misleading TESTFN description, and looked at the docs of similar functions (assq, assoc).
prev parent reply other threads:[~2019-04-09 14:59 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-09 10:34 bug#35206: [PATCH] Misleading `list-get' argument description Mattias Engdegård
2019-04-09 11:00 ` Eli Zaretskii
2019-04-09 11:26 ` Mattias Engdegård
2019-04-09 11:45 ` Mattias Engdegård
2019-04-09 14:41 ` Eli Zaretskii
2019-04-09 14:59 ` Mattias Engdegård [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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=948BCACD-D6CE-46AD-A31A-82272AB1A077@acm.org \
--to=mattiase@acm.org \
--cc=35206-done@debbugs.gnu.org \
--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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).