From: Richard M. Stallman <rms@gnu.org>
Date: Mon, 3 Jul 2006 15:53:33 +0000 (+0000)
Subject: (read-face-name): Doc fix.
X-Git-Tag: emacs-pretest-22.0.90~1732
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3748d13d31860f6de2a308be78dafb7fcc618ad1;p=emacs.git

(read-face-name): Doc fix.
---

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)