]> git.eshelyaron.com Git - emacs.git/commitdiff
* doc/lispref/minibuf.texi (High-Level Completion): Updates for read-color.
authorGlenn Morris <rgm@gnu.org>
Sat, 4 Feb 2012 01:23:09 +0000 (20:23 -0500)
committerGlenn Morris <rgm@gnu.org>
Sat, 4 Feb 2012 01:23:09 +0000 (20:23 -0500)
* etc/NEWS: Likewise.

doc/lispref/ChangeLog
doc/lispref/minibuf.texi
etc/NEWS

index 45dc76732124a4e92870c41d17a849e4f9e20394..36780b20248b5c4b21514fd93637a037ec8d6a08 100644 (file)
@@ -1,3 +1,7 @@
+2012-02-04  Glenn Morris  <rgm@gnu.org>
+
+       * minibuf.texi (High-Level Completion): Updates for read-color.
+
 2012-02-03  Glenn Morris  <rgm@gnu.org>
 
        * display.texi (GIF Images): Mention animation.
index e3008470233f3340dd3df3cc2f900375b96ffcdb..a71138f52689d1eba28fef41274225af51532ec9 100644 (file)
@@ -1335,19 +1335,19 @@ but uses the predicate @code{user-variable-p} instead of
 @deffn Command read-color &optional prompt convert allow-empty display
 This function reads a string that is a color specification, either the
 color's name or an RGB hex value such as @code{#RRRGGGBBB}.  It
-prompts with @var{prompt} (default: @code{"Color (name or #R+G+B+):"})
+prompts with @var{prompt} (default: @code{"Color (name or #RGB triplet):"})
 and provides completion for color names, but not for hex RGB values.
 In addition to names of standard colors, completion candidates include
 the foreground and background colors at point.
 
 Valid RGB values are described in @ref{Color Names}.
 
-The function's return value is the color name typed by the user in the
+The function's return value is the string typed by the user in the
 minibuffer.  However, when called interactively or if the optional
-argument @var{convert} is non-@code{nil}, it converts the name into
-the color's RGB value and returns that value as a string.  If an
-invalid color name was specified, this function signals an error,
-except that empty color names are allowed when @code{allow-empty} is
+argument @var{convert} is non-@code{nil}, it converts any input color
+name into the corresponding RGB value string and instead returns that.
+This function requires a valid color specification to be input.
+Empty color names are allowed when @code{allow-empty} is
 non-@code{nil} and the user enters null input.
 
 Interactively, or when @var{display} is non-@code{nil}, the return
index 0e9181d76755d23d90df7e087e9608334d54302d..99be115e108cba38c8e0c4f8b1379e57d337fd5b 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1310,10 +1310,13 @@ Trashing is performed if TRASH and `delete-by-moving-to-trash' are
 both non-nil.  Interactively, TRASH defaults to t, unless a prefix
 argument is supplied (see Trash changes, above).
 
+---
 ** `facemenu-read-color' is now an alias for `read-color'.
-The command `read-color' now requires a match for a color name or RGB
-triplet, instead of signaling an error if the user provides a invalid
-input.
+
++++
+** The command `read-color' now requires a match for a color name
+or RGB triplet, instead of signaling an error if the user provides
+invalid input.
 
 ** Tool-bars can display separators.
 Tool-bar separators are handled like menu separators in menu-bar maps,