Skip to content

Commit ac76ec2

Browse files
committed
doc: update test concurrency description / default value
1 parent 6d92cc7 commit ac76ec2

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc/api/test.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -728,10 +728,9 @@ changes:
728728
properties are supported:
729729
* `concurrency` {number|boolean} If a number is provided,
730730
then that many tests would run in parallel.
731-
If truthy, it would run (number of cpu cores - 1)
732-
tests in parallel.
731+
If `true`, it would run `os.availableParallelism() - 1` files in parallel.
733732
For subtests, it will be `Infinity` tests in parallel.
734-
If falsy, it would only run one test at a time.
733+
If `false`, it would only run one test at a time.
735734
If unspecified, subtests inherit this value from their parent.
736735
**Default:** `false`.
737736
* `only` {boolean} If truthy, and the test context is configured to run
@@ -1645,9 +1644,12 @@ changes:
16451644
`fn` does not have a name.
16461645
* `options` {Object} Configuration options for the subtest. The following
16471646
properties are supported:
1648-
* `concurrency` {number} The number of tests that can be run at the same time.
1647+
* `concurrency` {number|boolean} If a number is provided,
1648+
then that many files would run in parallel.
1649+
If `true`, it would run `os.availableParallelism() - 1` files in parallel.
1650+
If `false`, it would only run one test at a time.
16491651
If unspecified, subtests inherit this value from their parent.
1650-
**Default:** `1`.
1652+
**Default:** `false`.
16511653
* `only` {boolean} If truthy, and the test context is configured to run
16521654
`only` tests, then this test will be run. Otherwise, the test is skipped.
16531655
**Default:** `false`.

0 commit comments

Comments
 (0)