From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Sat, 12 Oct 2019 19:34:56 +0000 (+0200)
Subject: ert-deftest macro doc string clarification
X-Git-Tag: emacs-27.0.90~1126
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3fcfa8071ac820c2a857b890de31ba5517d7249e;p=emacs.git

ert-deftest macro doc string clarification

* lisp/emacs-lisp/ert.el (ert-deftest): Mention that macros are
expanded when defined, not when tested (bug#21742).
---

diff --git a/lisp/emacs-lisp/ert.el b/lisp/emacs-lisp/ert.el
index da241e6304f..68762b0752c 100644
--- a/lisp/emacs-lisp/ert.el
+++ b/lisp/emacs-lisp/ert.el
@@ -192,6 +192,10 @@ Tests that are expected to fail can be marked as such
 using :expected-result.  See `ert-test-result-type-p' for a
 description of valid values for RESULT-TYPE.
 
+Macros in BODY are expanded when the test is defined, not when it
+is run.  If a macro (possibly with side effects) is to be tested,
+it has to be wrapped in `(eval (quote ...))'.
+
 \(fn NAME () [DOCSTRING] [:expected-result RESULT-TYPE] \
 [:tags \\='(TAG...)] BODY...)"
   (declare (debug (&define :name test