[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/buttercup 818c150 239/340: docs: Clarify the difference be
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/buttercup 818c150 239/340: docs: Clarify the difference between :var and `let' |
Date: |
Thu, 16 Dec 2021 14:59:42 -0500 (EST) |
branch: elpa/buttercup
commit 818c150db7ebf4333a9d927fbd80877a332c4d19
Author: Ola Nilsson <ola.nilsson@gmail.com>
Commit: Ola Nilsson <ola.nilsson@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,
- [nongnu] elpa/buttercup 075b318 198/340: Add support for :var*, (continued)
- [nongnu] elpa/buttercup 075b318 198/340: Add support for :var*, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 1c762a5 200/340: Add documentation for :var and :var*, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 159fe3c 203/340: Really fix the buttercup-run tests, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup d2b6692 206/340: Bump version: 1.16 → 1.17, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup e62ce43 207/340: test: Do not leak functions from "The Spy " test suite, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 8b3cfad 214/340: Update test for new warning capture suppression behavior, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 1567c03 215/340: Add emacs-26.3 to CI config, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 6cf8041 229/340: Update writing-tests.md to describe new spy context structs, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup c720cef 233/340: Merge pull request #146 from DarwinAwardWinner/spy-record-errors, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup b2edd35 235/340: Change: (buttercup-define-matcher-for-binary-function) Add newlines, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 818c150 239/340: docs: Clarify the difference between :var and `let',
ELPA Syncer <=
- [nongnu] elpa/buttercup d8ab09d 244/340: Update documentation for the --pattern option in running-tests.md, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup adba24e 246/340: Bump version: 1.19 → 1.20, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup e7e5d22 248/340: Add an option to immediately abort Buttercup run if a test fails, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup dcc2638 249/340: Revert "Add an option to immediately abort Buttercup run if a test fails", ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 9b30c75 252/340: Make buttercup-x?it and buttercup-suite-add-child return spec, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 3734152 251/340: Make buttercup-describe return the created suite object, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 8271c27 254/340: Only update spec state if it is worse or equal, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 966798f 255/340: Correct all docstrings to pass checkdoc, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup b520dcf 257/340: Print test run duration in an apropriate unit, ELPA Syncer, 2021/12/16
- [nongnu] elpa/buttercup 1fd0d8b 260/340: Set state pending for skipped specs for correct initial count, ELPA Syncer, 2021/12/16