diff options
| author | Mauro Aranda <maurooaranda@gmail.com> | 2020-09-04 14:50:40 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2020-09-04 14:50:40 +0200 |
| commit | 0f793b5658b0a3610c5b5cad5dd8558d5d11ddfe (patch) | |
| tree | 287989b204283880600bedcdf85bb4cca4be0a93 | |
| parent | 689f4212520bfe96cc8b060c4514abe7f97d0d64 (diff) | |
| download | emacs-0f793b5658b0a3610c5b5cad5dd8558d5d11ddfe.tar.gz | |
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).
| -rw-r--r-- | doc/lispref/customize.texi | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index b9c9130a920..c35444f5817 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 |