Function: faceup-defexplainer

faceup-defexplainer is an autoloaded macro defined in faceup.el.gz.

Signature

(faceup-defexplainer FUNCTION)

Documentation

Define an Ert explainer function for FUNCTION.

FUNCTION must return an explanation when the test fails and faceup-test-explain is set.

Source Code

;; Defined in /usr/src/emacs/lisp/emacs-lisp/faceup.el.gz
;;;###autoload
(defmacro faceup-defexplainer (function)
  "Define an Ert explainer function for FUNCTION.

FUNCTION must return an explanation when the test fails and
`faceup-test-explain' is set."
  (let ((name (intern (concat (symbol-name function) "-explainer"))))
    `(progn
       (defun ,name (&rest args)
         (let ((faceup-test-explain t))
           (apply (quote ,function) args)))
       (put (quote ,function) 'ert-explainer (quote ,name)))))