[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#23548: 25.0.93; lists.texi (alist-get): Document optional arg 'remov
From: |
Tino Calancha |
Subject: |
bug#23548: 25.0.93; lists.texi (alist-get): Document optional arg 'remove'. |
Date: |
Mon, 16 May 2016 23:13:35 +0900 (JST) |
User-agent: |
Alpine 2.20 (LRH 67 2015-01-07) |
* doc/lispref/lists.texi (alist-get): Document optional arg. 'remove'.
Rename second argument to 'alist'.
In GNU Emacs 25.0.93.3 (x86_64-pc-linux-gnu, GTK+ Version 2.24.30)
Repository revision: 6de0715f5467d4b925e2dfe082174529ace3b174
From 23f7df037e23c867cfa0090936c9f974e6e83175 Mon Sep 17 00:00:00 2001
From: Tino Calancha <f92capac@gmail.com>
Date: Mon, 16 May 2016 23:01:14 +0900
Subject: [PATCH] ; * lists.texi (alist-get): Document optional arg 'remove'.
---
doc/lispref/lists.texi | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi
index c18c408..7d411af 100644
--- a/doc/lispref/lists.texi
+++ b/doc/lispref/lists.texi
@@ -1556,12 +1556,17 @@ Association Lists
@end smallexample
@end defun
-@defun alist-get key value &optional default
+@defun alist-get key alist &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.
+
+When using this function to set the value at @var{key}
+to @var{new-val}, if @var{remove} evaluates non-@code{nil} and
+@var{default} is @code{eql} to @var{new-val}, then the entry at
+@var{key} is deleted.
@end defun
@defun rassq value alist
--
2.8.1
- bug#23548: 25.0.93; lists.texi (alist-get): Document optional arg 'remove'.,
Tino Calancha <=