[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

read-face-name doc string incorrect

From: Drew Adams
Subject: read-face-name doc string incorrect
Date: Sat, 24 Jun 2006 19:47:39 -0700

The doc string for read-face-name says this:

 Read a face, defaulting to the face or faces on the char after point.
 If it has a `read-face-name' property, 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.
 If multiple is non-nil, return a list of faces (possibly only one).
 Otherwise, return a single face.

The part about "if this function returns nil" is incorrect. The
function never returns nil - it returns a non-empty list of faces or a
single face. This should say something to the effect of "if the user
just hits RET".

The prompt and default-string are not clear, in any case, especially
the part about describing what you will do with the face and not
ending in a space. The doc string must give an example, or no one will
understand what kind of prompt string and default-string arguments to

In GNU Emacs (i386-mingw-nt5.1.2600)
 of 2006-03-20 on W2ONE
X server distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --cflags -Id:/g/include'

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: ENU
  locale-coding-system: cp1252
  default-enable-multibyte-characters: t

Major mode: Dired by name

Minor modes in effect:
  encoded-kbd-mode: t
  tooltip-mode: t
  auto-compression-mode: t
  tool-bar-mode: t
  mouse-wheel-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  unify-8859-on-encoding-mode: t
  utf-translate-cjk-mode: t
  line-number-mode: t

Recent input:
<help-echo> <help-echo> <help-echo> <help-echo> <menu-bar>
<help-menu> <report-emacs-bug>

Recent messages:
(C:\Emacs-22-2006-03-20\bin\emacs.exe -q --no-site-file --debug-init
Loading encoded-kb...done
For information about the GNU Project and its goals, type C-h C-p.
Loading dired...
Loading regexp-opt...done
Loading dired...done
Loading emacsbug...done

reply via email to

[Prev in Thread] Current Thread [Next in Thread]