emacs-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[debbugs-tracker] bug#35206: closed ([PATCH] Misleading `list-get' argum


From: GNU bug Tracking System
Subject: [debbugs-tracker] bug#35206: closed ([PATCH] Misleading `list-get' argument description)
Date: Tue, 09 Apr 2019 15:00:02 +0000

Your message dated Tue, 9 Apr 2019 16:59:48 +0200
with message-id <address@hidden>
and subject line Re: bug#35206: [PATCH] Misleading `list-get' argument 
description
has caused the debbugs.gnu.org bug report #35206,
regarding [PATCH] Misleading `list-get' argument description
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden)


-- 
35206: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=35206
GNU Bug Tracking System
Contact address@hidden with problems
--- Begin Message --- Subject: [PATCH] Misleading `list-get' argument description Date: Tue, 9 Apr 2019 12:34:09 +0200
The doc string for `list-get' says

  Use TESTFN to lookup in the alist if non-nil.  Otherwise, use `assq'.

which is misleading since it's an equality predicate, not a look-up function, 
and the default is `eq', not `assq'.
How about changing it to

  Equality is defined by TESTFN or by `eq' if nil or omitted.

Attachment: 0001-Clarify-the-TESTFN-argument-to-alist-get.patch
Description: Binary data


--- End Message ---
--- Begin Message --- Subject: Re: bug#35206: [PATCH] Misleading `list-get' argument description Date: Tue, 9 Apr 2019 16:59:48 +0200
9 apr. 2019 kl. 16.41 skrev Eli Zaretskii <address@hidden>:
> 
>  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).



--- End Message ---

reply via email to

[Prev in Thread] Current Thread [Next in Thread]