[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 0f793b5: Document :type-error property for customization types
From: |
Lars Ingebrigtsen |
Subject: |
master 0f793b5: Document :type-error property for customization types |
Date: |
Fri, 4 Sep 2020 08:52:05 -0400 (EDT) |
branch: master
commit 0f793b5658b0a3610c5b5cad5dd8558d5d11ddfe
Author: Mauro Aranda <maurooaranda@gmail.com>
Commit: Lars Ingebrigtsen <larsi@gnus.org>
Document :type-error property for customization types
* 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 | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi
index b9c9130..c35444f 100644
--- a/doc/lispref/customize.texi
+++ b/doc/lispref/customize.texi
@@ -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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master 0f793b5: Document :type-error property for customization types,
Lars Ingebrigtsen <=