diff options
| author | Ola Nilsson <ola.nilsson@gmail.com> | 2018-08-28 21:39:52 +0200 |
|---|---|---|
| committer | Ola Nilsson <ola.nilsson@gmail.com> | 2018-08-28 22:51:08 +0200 |
| commit | f57036fdcc9337eccfdcb4e5ebc8c973863149e8 (patch) | |
| tree | 60d7bafca28351896aaeb7636c91c2a295f444fa | |
| parent | acccc0f043375f3840e7f108a85a5d9432e8f1f7 (diff) | |
Update the disabled/pending sections of writing-tests.md
The new xdescribe macro will handle pending suites differently.
| -rw-r--r-- | docs/writing-tests.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/writing-tests.md b/docs/writing-tests.md index b980a18..c478111 100644 --- a/docs/writing-tests.md +++ b/docs/writing-tests.md @@ -298,10 +298,11 @@ walks through the `after-each` functions similarly. ## Disabling Suites -Suites and specs can be disabled with the `xdescribe` and `xit` -macros, respectively. These suites and any specs inside them are -skipped when run and thus their results will not appear in the -results. +Suites and specs can be disabled by marking them as pending with the +`xdescribe` and `xit` macros, respectively. Any suites or specs inside +a `xdescribe' suite is also pending. Pending suites and specs will be +listed as pending in the results, but the containing code will not be +run. ```Emacs-Lisp (xdescribe "A spec" @@ -316,7 +317,7 @@ results. ## Pending Specs -Pending specs do not run. +Pending specs do not run, but will be listed in the results. Any spec declared with `xit` is marked as pending. |