]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify the TESTFN argument to `alist-get'
authorMattias EngdegÄrd <mattiase@acm.org>
Tue, 9 Apr 2019 14:56:37 +0000 (16:56 +0200)
committerEli Zaretskii <eliz@gnu.org>
Tue, 9 Apr 2019 16:10:47 +0000 (19:10 +0300)
* lisp/subr.el (alist-get):
Rephrase the initial text to clarify the meaning of the TESTFN argument.
It's an equality predicate, not a look-up function (Bug#35206).

(cherry picked from commit c81465580fe262f28ce47502c00f4afcbe3b8f8d)

lisp/subr.el

index 44199a50754d77ae77372110a3569907a71f31ab..54bee8a809f3c99e242000775300f6995d44874b 100644 (file)
@@ -752,9 +752,9 @@ Elements of ALIST that are not conses are ignored."
   alist)
 
 (defun alist-get (key alist &optional default remove testfn)
-  "Return the value associated with KEY in ALIST.
+  "Find the first element of ALIST whose `car' equals KEY and return its `cdr'.
 If KEY is not found in ALIST, return DEFAULT.
-Use TESTFN to lookup in the alist if non-nil.  Otherwise, use `assq'.
+Equality with KEY is tested by TESTFN, defaulting to `eq'.
 
 This is a generalized variable suitable for use with `setf'.
 When using it to set a value, optional argument REMOVE non-nil