all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* completing-read-multiple and read-face-name are not in Elisp manual
@ 2007-06-19 18:48 Drew Adams
  2007-06-19 22:09 ` Juri Linkov
  2007-06-20 13:28 ` Richard Stallman
  0 siblings, 2 replies; 6+ messages in thread
From: Drew Adams @ 2007-06-19 18:48 UTC (permalink / raw)
  To: Emacs-Devel

(Yes, I realize that not every function needs to be documented in the
manual - please don't bother with such a general reminder.) I think
`completing-read-multiple' and `read-face-name' should be documented.

Is `completing-read-multiple' not in the manual because `crm.el' is somehow
considered optional? `completing-read-multiple' is used in `read-face-name'
(where there is also a `require' of crm).

The doc string of `read-face-name' says nothing about the fact that you can
input and complete multiple face names. And nothing indicates to a user,
when `read-face-name' is called, that s?he can input and complete multiple
names, separating them with a comma. (Sure, a programmer can mention that in
the prompt, but s?he might not, especially since there is no info about this
in the doc string.) The doc string of read-face-name mentions the optional
MULTIPLE argument, but that is only for output, not input.

I find nothing about this behavior described anywhere in the Emacs manual or
the Elisp manual. How will users understand the UI? How will programmers
understand how these functions work (without examining the code in detail)?

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2007-06-20 14:07 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-06-19 18:48 completing-read-multiple and read-face-name are not in Elisp manual Drew Adams
2007-06-19 22:09 ` Juri Linkov
2007-06-19 22:47   ` Drew Adams
2007-06-20 14:07     ` Juri Linkov
2007-06-20 13:28 ` Richard Stallman
2007-06-20 13:41   ` Drew Adams

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.