[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 661f52f 1/2: Clarify the doc string of plist-memeber and plist-pu
From: |
Lars Ingebrigtsen |
Subject: |
master 661f52f 1/2: Clarify the doc string of plist-memeber and plist-put |
Date: |
Sun, 28 Mar 2021 09:19:53 -0400 (EDT) |
branch: master
commit 661f52f6d0d6576e8bddb8fcc6efec1bd1fd3d74
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>
Clarify the doc string of plist-memeber and plist-put
* src/fns.c (Fplist_member):
(Fplist_put): Clarify what comparison function is used for PROP
(bug#47426) and don't claim that PROP has to be a symbol.
---
src/fns.c | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/src/fns.c b/src/fns.c
index 2cd59c8..1758148 100644
--- a/src/fns.c
+++ b/src/fns.c
@@ -2369,7 +2369,10 @@ This is the last value stored with `(put SYMBOL PROPNAME
VALUE)'. */)
DEFUN ("plist-put", Fplist_put, Splist_put, 3, 3, 0,
doc: /* Change value in PLIST of PROP to VAL.
PLIST is a property list, which is a list of the form
-\(PROP1 VALUE1 PROP2 VALUE2 ...). PROP is a symbol and VAL is any object.
+\(PROP1 VALUE1 PROP2 VALUE2 ...).
+
+The comparison with PROP is done using `eq'.
+
If PROP is already a property on the list, its value is set to VAL,
otherwise the new PROP VAL pair is added. The new plist is returned;
use `(setq x (plist-put x prop val))' to be sure to use the new value.
@@ -3211,7 +3214,10 @@ suppressed. */)
DEFUN ("plist-member", Fplist_member, Splist_member, 2, 2, 0,
doc: /* Return non-nil if PLIST has the property PROP.
PLIST is a property list, which is a list of the form
-\(PROP1 VALUE1 PROP2 VALUE2 ...). PROP is a symbol.
+\(PROP1 VALUE1 PROP2 VALUE2 ...).
+
+The comparison with PROP is done using `eq'.
+
Unlike `plist-get', this allows you to distinguish between a missing
property and a property with the value nil.
The value is actually the tail of PLIST whose car is PROP. */)