aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/lists.texi24
1 files changed, 14 insertions, 10 deletions
diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi
index 966d8f18b17..0c993806824 100644
--- a/doc/lispref/lists.texi
+++ b/doc/lispref/lists.texi
@@ -1589,16 +1589,20 @@ keys may not be symbols:
1589@end smallexample 1589@end smallexample
1590@end defun 1590@end defun
1591 1591
1592@defun alist-get key alist &optional default remove 1592@defun alist-get key alist &optional default remove testfn
1593This function is like @code{assq}, but instead of returning the entire 1593This function is similar to @code{assq}. It finds the first
1594association for @var{key} in @var{alist}, 1594association @w{@code{(@var{key} . @var{value})}} by comparing
1595@w{@code{(@var{key} . @var{value})}}, it returns just the @var{value}. 1595@var{key} with @var{alist} elements, and, if found, returns the
1596If @var{key} is not found in @var{alist}, it returns @var{default}. 1596@var{value} of that association. If no association is found, the
1597 1597function returns @var{default}. Comparison of @var{key} against
1598This is a generalized variable (@pxref{Generalized Variables}) that 1598@var{alist} elements uses the function specified by @var{testfn},
1599can be used to change a value with @code{setf}. When using it to set 1599defaulting to @code{eq}.
1600a value, optional argument @var{remove} non-@code{nil} means to remove 1600
1601@var{key} from @var{alist} if the new value is @code{eql} to @var{default}. 1601This is a generalized variable (@pxref{Generalized Variables})
1602that can be used to change a value with @code{setf}. When
1603using it to set a value, optional argument @var{remove} non-@code{nil}
1604means to remove @var{key}'s association from @var{alist} if the new
1605value is @code{eql} to @var{default}.
1602@end defun 1606@end defun
1603 1607
1604@defun rassq value alist 1608@defun rassq value alist