summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMattias EngdegÄrd <mattiase@acm.org>2019-04-09 16:56:37 +0200
committerMattias EngdegÄrd <mattiase@acm.org>2019-04-09 16:56:37 +0200
commitc81465580fe262f28ce47502c00f4afcbe3b8f8d (patch)
treeee148a7a9ffa35a2e94d2bd6595978b70973d7d1
parent44b306d3510e54432b76724583ea9405f1c90686 (diff)
downloademacs-c81465580fe262f28ce47502c00f4afcbe3b8f8d.tar.gz
Clarify the TESTFN argument to `alist-get'
* 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).
-rw-r--r--lisp/subr.el4
1 files changed, 2 insertions, 2 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 45b39161965..bdf98979c49 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -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