From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 13 Jul 2019 14:44:03 +0000 (+0200)
Subject: plist-get/lax-plist-get doc fix
X-Git-Tag: emacs-27.0.90~1946
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=d4c2b3ca64efb61d832f8ae1cba95d82059814a9;p=emacs.git

plist-get/lax-plist-get doc fix

* src/fns.c (Fplist_get): Mention that comparison is done with eq
(bug#31441).
(Flax_plist_get): Refer to plist-get for details.
---

diff --git a/src/fns.c b/src/fns.c
index a61801bc77d..6a7c3477282 100644
--- a/src/fns.c
+++ b/src/fns.c
@@ -2161,9 +2161,13 @@ merge (Lisp_Object org_l1, Lisp_Object org_l2, Lisp_Object pred)
 DEFUN ("plist-get", Fplist_get, Splist_get, 2, 2, 0,
        doc: /* Extract a value from a property list.
 PLIST is a property list, which is a list of the form
-\(PROP1 VALUE1 PROP2 VALUE2...).  This function returns the value
-corresponding to the given PROP, or nil if PROP is not one of the
-properties on the list.  This function never signals an error.  */)
+\(PROP1 VALUE1 PROP2 VALUE2...).
+
+This function returns the value corresponding to the given PROP, or
+nil if PROP is not one of the properties on the list.  The comparison
+with PROP is done using `eq'.
+
+This function never signals an error.  */)
   (Lisp_Object plist, Lisp_Object prop)
 {
   Lisp_Object tail = plist;
@@ -2239,10 +2243,8 @@ It can be retrieved with `(get SYMBOL PROPNAME)'.  */)
 
 DEFUN ("lax-plist-get", Flax_plist_get, Slax_plist_get, 2, 2, 0,
        doc: /* Extract a value from a property list, comparing with `equal'.
-PLIST is a property list, which is a list of the form
-\(PROP1 VALUE1 PROP2 VALUE2...).  This function returns the value
-corresponding to the given PROP, or nil if PROP is not
-one of the properties on the list.  */)
+This function is otherwise like `plist-get', but may signal an error
+if PLIST isn't a valid plist.  */)
   (Lisp_Object plist, Lisp_Object prop)
 {
   Lisp_Object tail = plist;