unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#12912: 24.3.50; doc string for `read-face-name'
@ 2012-11-17  0:37 Drew Adams
  2012-11-17  0:50 ` Drew Adams
  2013-01-09  9:46 ` Chong Yidong
  0 siblings, 2 replies; 3+ messages in thread
From: Drew Adams @ 2012-11-17  0:37 UTC (permalink / raw)
  To: 12912

This doc seems to be incomplete and unclear wrt DEFAULT.
 
It speaks of a case where DEFAULT is not a string.  It does not say what
else it must/can be (besides nil).  Can it be a symbol - e.g., a face
symbol?  Can it be a list of strings, i.e., multiple defaults?  A list
of faces (symbols)?
 
What's more, there is nothing in the doc string that indicates that the
face name(s) is/are read using `completing-read-multiple'.  Not that
that implementation detail need be mentioned explicitly, but its
_behavior_, i.e., what the behavior of `read-face-name' is, should be
described.
 
In GNU Emacs 24.3.50.1 (i386-mingw-nt5.1.2600)
 of 2012-11-05 on MS-W7-DANI
Bzr revision: 110809 lekktu@gmail.com-20121105172930-a5gn0bwi4lndchhw
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -I../../libs/libXpm-3.5.10/include -I../../libs/libXpm-3.5.10/src
 -I../../libs/libpng-1.2.37-lib/include -I../../libs/zlib-1.2.5
 -I../../libs/giflib-4.1.4-1-lib/include
 -I../../libs/jpeg-6b-4-lib/include
 -I../../libs/tiff-3.8.2-1-lib/include
 -I../../libs/libxml2-2.7.8-w32-bin/include/libxml2
 -I../../libs/gnutls-3.0.9-w32-bin/include
 -I../../libs/libiconv-1.9.2-1-lib/include'
 






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

* bug#12912: 24.3.50; doc string for `read-face-name'
  2012-11-17  0:37 bug#12912: 24.3.50; doc string for `read-face-name' Drew Adams
@ 2012-11-17  0:50 ` Drew Adams
  2013-01-09  9:46 ` Chong Yidong
  1 sibling, 0 replies; 3+ messages in thread
From: Drew Adams @ 2012-11-17  0:50 UTC (permalink / raw)
  To: 12912

The doc string is also bad wrt PROMPT.  It correctly says that it should not end
in a space, but it should also say that it should not end in a colon.

In fact, it would be far more understandable if it said (as I think we say
elsewhere for such silly prompt handling) that ": " will automatically be
appended to PROMPT.  That tells you the reason and everything you need to know.






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

* bug#12912: 24.3.50; doc string for `read-face-name'
  2012-11-17  0:37 bug#12912: 24.3.50; doc string for `read-face-name' Drew Adams
  2012-11-17  0:50 ` Drew Adams
@ 2013-01-09  9:46 ` Chong Yidong
  1 sibling, 0 replies; 3+ messages in thread
From: Chong Yidong @ 2013-01-09  9:46 UTC (permalink / raw)
  To: Drew Adams; +Cc: 12912-done

"Drew Adams" <drew.adams@oracle.com> writes:

> This doc seems to be incomplete and unclear wrt DEFAULT.
>  
> It speaks of a case where DEFAULT is not a string.  It does not say what
> else it must/can be (besides nil).  Can it be a symbol - e.g., a face
> symbol?  Can it be a list of strings, i.e., multiple defaults?  A list
> of faces (symbols)?
>  
> What's more, there is nothing in the doc string that indicates that the
> face name(s) is/are read using `completing-read-multiple'.  Not that
> that implementation detail need be mentioned explicitly, but its
> _behavior_, i.e., what the behavior of `read-face-name' is, should be
> described.

Should be fixed now, thanks.





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

end of thread, other threads:[~2013-01-09  9:46 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-11-17  0:37 bug#12912: 24.3.50; doc string for `read-face-name' Drew Adams
2012-11-17  0:50 ` Drew Adams
2013-01-09  9:46 ` Chong Yidong

Code repositories for project(s) associated with this public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).