summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2006-07-03 15:53:33 +0000
committerRichard M. Stallman <rms@gnu.org>2006-07-03 15:53:33 +0000
commit072ab6d6d86fafafde330083cea4ed5d6a8e2108 (patch)
tree37f04fba71efcbecc0b253135f7d75c1b8648897
parent3c38e84f9483ff30c25c36e87a586585b15a62f5 (diff)
downloademacs-072ab6d6d86fafafde330083cea4ed5d6a8e2108.tar.gz
(read-face-name): Doc fix.
-rw-r--r--lisp/faces.el7
1 files changed, 4 insertions, 3 deletions
diff --git a/lisp/faces.el b/lisp/faces.el
index 2d761ea8471..0f0dd41aa69 100644
--- a/lisp/faces.el
+++ b/lisp/faces.el
@@ -860,9 +860,10 @@ of the default face. Value is FACE."
(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)