chore: add a parallel mode note (#11943)

This commit is contained in:
Pavel Feldman 2022-02-08 14:36:14 -08:00 committed by GitHub
parent 9ce8572c78
commit 4bcca2c87e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions

View File

@ -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.

View File

@ -1640,9 +1640,8 @@ export interface TestType<TestArgs extends KeyValue, WorkerArgs extends KeyValue
* 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.
*
* 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: 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<TestArgs extends KeyValue, WorkerArgs extends KeyValue
* but using [test.describe.parallel(title, callback)](https://playwright.dev/docs/api/class-test#test-describe-parallel)
* allows them to run in parallel.
*
* 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: 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', () => {