From 1c5041375307e2b13c7ff44bd784b64a0ffae764 Mon Sep 17 00:00:00 2001 From: Yakeen Sewsanker Date: Wed, 11 Mar 2020 23:22:32 +0000 Subject: [PATCH] =?UTF-8?q?Fixed=20documentation=20for=20setupFilesAfterEn?= =?UTF-8?q?v=20to=20correctly=20state=20t=E2=80=A6=20(#9651)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Configuration.md | 2 +- website/versioned_docs/version-22.x/Configuration.md | 2 +- website/versioned_docs/version-23.x/Configuration.md | 2 +- website/versioned_docs/version-24.x/Configuration.md | 2 +- website/versioned_docs/version-25.1/Configuration.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Configuration.md b/docs/Configuration.md index 5339a82b1c5a..9a8eed414769 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -770,7 +770,7 @@ It's also worth noting that `setupFiles` will execute _before_ [`setupFilesAfter Default: `[]` -A list of paths to modules that run some code to configure or set up the testing framework before each test. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. +A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. If you want a path to be [relative to the root directory of your project](#rootdir-string), please include `` inside a path's string, like `"/a-configs-folder"`. diff --git a/website/versioned_docs/version-22.x/Configuration.md b/website/versioned_docs/version-22.x/Configuration.md index b08156125fb6..76814adff6f7 100644 --- a/website/versioned_docs/version-22.x/Configuration.md +++ b/website/versioned_docs/version-22.x/Configuration.md @@ -573,7 +573,7 @@ async runTests( Default: `[]` -The paths to modules that run some code to configure or set up the testing environment before each test. Since every test runs in its own environment, these scripts will be executed in the testing environment immediately before executing the test code itself. +The paths to modules that run some code to configure or set up the testing environment before each test file in the suite is executed. Since every test runs in its own environment, these scripts will be executed in the testing environment immediately before executing the test code itself. It's worth noting that this code will execute _before_ [`setupTestFrameworkScriptFile`](#setuptestframeworkscriptfile-string). diff --git a/website/versioned_docs/version-23.x/Configuration.md b/website/versioned_docs/version-23.x/Configuration.md index d4dbe35aba76..d3abda1eaac5 100644 --- a/website/versioned_docs/version-23.x/Configuration.md +++ b/website/versioned_docs/version-23.x/Configuration.md @@ -643,7 +643,7 @@ It's also worth noting that `setupFiles` will execute _before_ [`setupTestFramew Default: `undefined` -The path to a module that runs some code to configure or set up the testing framework before each test. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. +The path to a module that runs some code to configure or set up the testing framework before each test file in the suite is executed. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. If you want this path to be [relative to the root directory of your project](#rootdir-string), please include `` inside the path string, like `"/a-configs-folder"`. diff --git a/website/versioned_docs/version-24.x/Configuration.md b/website/versioned_docs/version-24.x/Configuration.md index 3c42bda44731..5a32f8a5dd16 100644 --- a/website/versioned_docs/version-24.x/Configuration.md +++ b/website/versioned_docs/version-24.x/Configuration.md @@ -747,7 +747,7 @@ It's also worth noting that `setupFiles` will execute _before_ [`setupFilesAfter Default: `[]` -A list of paths to modules that run some code to configure or set up the testing framework before each test. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. +A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. If you want a path to be [relative to the root directory of your project](#rootdir-string), please include `` inside a path's string, like `"/a-configs-folder"`. diff --git a/website/versioned_docs/version-25.1/Configuration.md b/website/versioned_docs/version-25.1/Configuration.md index 7f8b64da8597..4ffbbd9a9090 100644 --- a/website/versioned_docs/version-25.1/Configuration.md +++ b/website/versioned_docs/version-25.1/Configuration.md @@ -758,7 +758,7 @@ It's also worth noting that `setupFiles` will execute _before_ [`setupFilesAfter Default: `[]` -A list of paths to modules that run some code to configure or set up the testing framework before each test. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. +A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed. Since [`setupFiles`](#setupfiles-array) executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment. If you want a path to be [relative to the root directory of your project](#rootdir-string), please include `` inside a path's string, like `"/a-configs-folder"`.