]> 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)
committerMattias Engdegård <mattiase@acm.org>
Tue, 9 Apr 2019 14:56:37 +0000 (16:56 +0200)
* 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).

lisp/subr.el

index 45b391619658c6d39e67b0e657fc0044097a789c..bdf98979c49e79586f0bf22c2cdd96b93dcf6fbd 100644 (file)
@@ -779,9 +779,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'.
 
 You can use `alist-get' in PLACE expressions.  This will modify
 an existing association (more precisely, the first one if