From f57036fdcc9337eccfdcb4e5ebc8c973863149e8 Mon Sep 17 00:00:00 2001 From: Ola Nilsson Date: Tue, 28 Aug 2018 21:39:52 +0200 Subject: Update the disabled/pending sections of writing-tests.md The new xdescribe macro will handle pending suites differently. --- docs/writing-tests.md | 11 ++++++----- 1 file 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. -- cgit v1.2.3