Mercurial > emacs
changeset 71591:defa6bf31164
(read-face-name): Doc fix.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Mon, 03 Jul 2006 15:53:33 +0000 |
| parents | ad634ecfc7ad |
| children | 78e1e4fcd148 |
| files | lisp/faces.el |
| diffstat | 1 files changed, 4 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/faces.el Mon Jul 03 15:52:32 2006 +0000 +++ b/lisp/faces.el Mon Jul 03 15:53:33 2006 +0000 @@ -860,9 +860,10 @@ (defun read-face-name (prompt &optional string-describing-default multiple) "Read a face, defaulting to the face or faces on the char after point. If it has the property `read-face-name', that overrides the `face' property. -PROMPT describes what you will do with the face (don't end in a space). -STRING-DESCRIBING-DEFAULT describes what default you will use -if this function returns nil. +PROMPT should be a string that describes what the caller will do with the face; +it should not end in a space. +STRING-DESCRIBING-DEFAULT should describe what default the caller will use if +the user just types RET; you can omit it. If MULTIPLE is non-nil, return a list of faces (possibly only one). Otherwise, return a single face." (let ((faceprop (or (get-char-property (point) 'read-face-name)