]> git.eshelyaron.com Git - emacs.git/commitdiff
Document :type-error property for customization types
authorMauro Aranda <maurooaranda@gmail.com>
Fri, 4 Sep 2020 12:50:40 +0000 (14:50 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Fri, 4 Sep 2020 12:50:40 +0000 (14:50 +0200)
* doc/lispref/customize.texi (Type Keywords): Document :type-error, so
Lisp programs can display a more correct message when the value of a
user option doesn't match its type (bug#23975).

doc/lispref/customize.texi

index b9c9130a9209c8e8cae752e3072b70bea20f5bd1..c35444f58170efe4a3dc123f8710239fb41945e3 100644 (file)
@@ -1197,6 +1197,13 @@ current value is valid for the widget.  Otherwise, it should return
 the widget containing the invalid data, and set that widget's
 @code{:error} property to a string explaining the error.
 
+@item :type-error @var{string}
+@kindex type-error@r{, customization keyword}
+@var{string} should be a string that describes why a value doesn't
+match the type, as determined by the @code{:match} function.  When the
+@code{:match} function returns @code{nil}, the widget's @code{:error}
+property will be set to @var{string}.
+
 @ignore
 @item :indent @var{columns}
 Indent this item by @var{columns} columns.  The indentation is used for