From 4bcca2c87e989c3330dcc840cb3661b8b0cdfe81 Mon Sep 17 00:00:00 2001 From: Pavel Feldman Date: Tue, 8 Feb 2022 14:36:14 -0800 Subject: [PATCH] chore: add a parallel mode note (#11943) --- docs/src/test-api/class-test.md | 4 ++++ packages/playwright-test/types/test.d.ts | 9 ++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/src/test-api/class-test.md b/docs/src/test-api/class-test.md index df33e24f64..fd831db1f0 100644 --- a/docs/src/test-api/class-test.md +++ b/docs/src/test-api/class-test.md @@ -334,7 +334,9 @@ A callback that is run immediately when calling [`method: Test.describe.only`]. Declares a group of tests that could be run in parallel. By default, tests in a single test file run one after another, but using [`method: Test.describe.parallel`] allows them to run in parallel. +:::note See [`method: Test.describe.configure`] for the preferred way of configuring the execution mode. +::: ```js js-flavor=js test.describe.parallel('group', () => { @@ -384,7 +386,9 @@ A callback that is run immediately when calling [`method: Test.describe.parallel Declares a group of tests that should always be run serially. If one of the tests fails, all subsequent tests are skipped. All tests in a group are retried together. +:::note See [`method: Test.describe.configure`] for the preferred way of configuring the execution mode. +::: :::note Using serial is not recommended. It is usually better to make your tests isolated, so they can be run independently. diff --git a/packages/playwright-test/types/test.d.ts b/packages/playwright-test/types/test.d.ts index df398388b8..365bc7ad5e 100644 --- a/packages/playwright-test/types/test.d.ts +++ b/packages/playwright-test/types/test.d.ts @@ -1640,9 +1640,8 @@ export interface TestType NOTE: See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for + * the preferred way of configuring the execution mode. * > NOTE: Using serial is not recommended. It is usually better to make your tests isolated, so they can be run * independently. * @@ -1686,8 +1685,8 @@ export interface TestType NOTE: See [test.describe.configure([options])](https://playwright.dev/docs/api/class-test#test-describe-configure) for + * the preferred way of configuring the execution mode. * * ```ts * test.describe.parallel('group', () => {