all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "Emacs-Devel" <emacs-devel@gnu.org>
Subject: completing-read-multiple and read-face-name are not in Elisp manual
Date: Tue, 19 Jun 2007 11:48:45 -0700	[thread overview]
Message-ID: <BDEIJAFNGDOAGCJIPKPBOECPCFAA.drew.adams@oracle.com> (raw)

(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)?

             reply	other threads:[~2007-06-19 18:48 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-06-19 18:48 Drew Adams [this message]
2007-06-19 22:09 ` completing-read-multiple and read-face-name are not in Elisp manual 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

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=BDEIJAFNGDOAGCJIPKPBOECPCFAA.drew.adams@oracle.com \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.