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).
This commit is contained in:
Lars Ingebrigtsen 2019-10-12 21:34:56 +02:00
parent cb24f4a145
commit 3fcfa8071a

View file

@ -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