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).
This commit is contained in:
parent
689f421252
commit
0f793b5658
1 changed files with 7 additions and 0 deletions
|
@ -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
|
||||
|
|
Loading…
Add table
Reference in a new issue