branch: elpa/buttercup
commit 818c150db7ebf4333a9d927fbd80877a332c4d19
Author: Ola Nilsson <ola.nils...@gmail.com>
Commit: Ola Nilsson <ola.nils...@gmail.com>
docs: Clarify the difference between :var and `let'
Fixes #140.
---
docs/writing-tests.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/writing-tests.md b/docs/writing-tests.md
index 43a4da5..8ff86e0 100644
--- a/docs/writing-tests.md
+++ b/docs/writing-tests.md
@@ -226,6 +226,10 @@ It's important to note that `lexical-binding` must be
`non-nil` for
`:var` and `:var*` to work properly. Within a test file this is
usually set using a local file variable.
+Using `:var` and `:var*` works just like the `let` equivalents, but
+it's recommended to use the `:var` format to be future proof. Future
+internal changes in `buttercup` could break suites using `let`.
+
### Setup and Teardown
To help a test suite DRY up any duplicated setup and teardown code,
