[Emacs-diffs] master 554001d: Type checking for `define-widget'

[Daniel Colascione]

branch: master
commit 554001dfa90be447dc0c71c596eb837d8e3b374b
Author: Daniel Colascione <address@hidden>
Commit: Daniel Colascione <address@hidden>

    Type checking for `define-widget'
    
    * lisp/widget.el (define-widget): Check that documentation is a string
    or nil; prevent wailing and gnashing of teeth when users forget to
    pass a docstring and wonder why their properties don't work.
---
 lisp/ChangeLog |    4 ++++
 lisp/widget.el |    3 +++
 2 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 8da573e..5004924 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,5 +1,9 @@
 2015-03-14  Daniel Colascione  <address@hidden>
 
+       * widget.el (define-widget): Check that documentation is a string
+       or nil; prevent wailing and gnashing of teeth when users forget to
+       pass a docstring and wonder why their properties don't work.
+
        * startup.el (command-line): Process "--no-x-resources".
 
 2015-03-13  Kevin Ryde  <address@hidden>
diff --git a/lisp/widget.el b/lisp/widget.el
index f8faa0f..539f91e 100644
--- a/lisp/widget.el
+++ b/lisp/widget.el
@@ -83,6 +83,9 @@ create identical widgets:
 * (apply 'widget-create CLASS ARGS)
 
 The third argument DOC is a documentation string for the widget."
+  ;;
+  (unless (or (null doc) (stringp doc))
+    (error "widget documentation must be `nil' or a string."))
   (put name 'widget-type (cons class args))
   (put name 'widget-documentation (purecopy doc))
   name)