diff options
| author | Glenn Morris <rgm@gnu.org> | 2016-06-07 19:59:37 -0400 |
|---|---|---|
| committer | Glenn Morris <rgm@gnu.org> | 2016-06-07 19:59:37 -0400 |
| commit | 1f85b7ca034ee4f96d796d95ec86bc4fa0ba8aa3 (patch) | |
| tree | 601774c89a6ccbc6686c3a15c35dfaa92d539381 /doc/lispref/lists.texi | |
| parent | ba3f206239349b725a970c7015f7f4ee8631ef6d (diff) | |
| download | emacs-1f85b7ca034ee4f96d796d95ec86bc4fa0ba8aa3.tar.gz | |
Doc fixes re alist-get. (Bug#23548)
* lisp/subr.el (alist-get): Doc fix.
* doc/lispref/lists.texi (Association Lists): Improve alist-get.
; * etc/NEWS: Related edit.
Diffstat (limited to 'doc/lispref/lists.texi')
| -rw-r--r-- | doc/lispref/lists.texi | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi index c18c408209a..e7a739f88f3 100644 --- a/doc/lispref/lists.texi +++ b/doc/lispref/lists.texi @@ -1556,12 +1556,16 @@ keys may not be symbols: @end smallexample @end defun -@defun alist-get key value &optional default +@defun alist-get key value &optional default remove This function is like @code{assq}, but instead of returning the entire association for @var{key}, @code{(@var{key} . @var{value})}, it -returns just the @var{value}. It returns @var{default} if @var{key} -is not found in @var{alist}, defaulting to @code{nil} if @var{default} -is omitted. +returns just the @var{value}. If @var{key} is not found in +@var{alist} it returns @var{default}. + +This is a generalized variable (@pxref{Generalized Variables}) that +can be used to change a value with @code{setf}. When using it to set +a value, optional argument @var{remove} non-nil means to remove +@var{key} from @var{alist} if the new value is @code{eql} to @var{default}. @end defun @defun rassq value alist |