diff options
| author | Lars Ingebrigtsen | 2021-03-28 14:58:43 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen | 2021-03-28 15:19:47 +0200 |
| commit | 661f52f6d0d6576e8bddb8fcc6efec1bd1fd3d74 (patch) | |
| tree | 89c479378cc14f4b1f06ca9ac7e0251b47bf3729 /src | |
| parent | aceaa0a334a9e1a90ba3715e144d147a77aedc95 (diff) | |
| download | emacs-661f52f6d0d6576e8bddb8fcc6efec1bd1fd3d74.tar.gz emacs-661f52f6d0d6576e8bddb8fcc6efec1bd1fd3d74.zip | |
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.
Diffstat (limited to 'src')
| -rw-r--r-- | src/fns.c | 10 |
1 files changed, 8 insertions, 2 deletions
| @@ -2369,7 +2369,10 @@ This is the last value stored with `(put SYMBOL PROPNAME VALUE)'. */) | |||
| 2369 | DEFUN ("plist-put", Fplist_put, Splist_put, 3, 3, 0, | 2369 | DEFUN ("plist-put", Fplist_put, Splist_put, 3, 3, 0, |
| 2370 | doc: /* Change value in PLIST of PROP to VAL. | 2370 | doc: /* Change value in PLIST of PROP to VAL. |
| 2371 | PLIST is a property list, which is a list of the form | 2371 | PLIST is a property list, which is a list of the form |
| 2372 | \(PROP1 VALUE1 PROP2 VALUE2 ...). PROP is a symbol and VAL is any object. | 2372 | \(PROP1 VALUE1 PROP2 VALUE2 ...). |
| 2373 | |||
| 2374 | The comparison with PROP is done using `eq'. | ||
| 2375 | |||
| 2373 | If PROP is already a property on the list, its value is set to VAL, | 2376 | If PROP is already a property on the list, its value is set to VAL, |
| 2374 | otherwise the new PROP VAL pair is added. The new plist is returned; | 2377 | otherwise the new PROP VAL pair is added. The new plist is returned; |
| 2375 | use `(setq x (plist-put x prop val))' to be sure to use the new value. | 2378 | use `(setq x (plist-put x prop val))' to be sure to use the new value. |
| @@ -3211,7 +3214,10 @@ suppressed. */) | |||
| 3211 | DEFUN ("plist-member", Fplist_member, Splist_member, 2, 2, 0, | 3214 | DEFUN ("plist-member", Fplist_member, Splist_member, 2, 2, 0, |
| 3212 | doc: /* Return non-nil if PLIST has the property PROP. | 3215 | doc: /* Return non-nil if PLIST has the property PROP. |
| 3213 | PLIST is a property list, which is a list of the form | 3216 | PLIST is a property list, which is a list of the form |
| 3214 | \(PROP1 VALUE1 PROP2 VALUE2 ...). PROP is a symbol. | 3217 | \(PROP1 VALUE1 PROP2 VALUE2 ...). |
| 3218 | |||
| 3219 | The comparison with PROP is done using `eq'. | ||
| 3220 | |||
| 3215 | Unlike `plist-get', this allows you to distinguish between a missing | 3221 | Unlike `plist-get', this allows you to distinguish between a missing |
| 3216 | property and a property with the value nil. | 3222 | property and a property with the value nil. |
| 3217 | The value is actually the tail of PLIST whose car is PROP. */) | 3223 | The value is actually the tail of PLIST whose car is PROP. */) |