Skip to content

doc: correct concurrency wording in test() documentation #60773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 20, 2025
Merged

doc: correct concurrency wording in test() documentation #60773

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1152fd
doc: correct concurrency wording in test() documentation
azadgupta1 Nov 18, 2025
11fc178
docs: update concurrency wording per reviewer suggestion
azadgupta1 Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1619,7 +1619,7 @@ changes:
* `options` {Object} Configuration options for the test. The following
properties are supported:
* `concurrency` {number|boolean} If a number is provided,
then that many tests would run in parallel within the application thread.
then that many tests would run asynchronously (they are still managed by the single-threaded event loop).
If `true`, all scheduled asynchronous tests run concurrently within the
thread. If `false`, only one test runs at a time.
If unspecified, subtests inherit this value from their parent.
Expand Down Expand Up @@ -3882,7 +3882,7 @@ changes:
* `options` {Object} Configuration options for the subtest. The following
properties are supported:
* `concurrency` {number|boolean|null} If a number is provided,
then that many tests would run in parallel within the application thread.
then that many tests would run asynchronously (they are still managed by the single-threaded event loop).
If `true`, it would run all subtests in parallel.
Copy link
Contributor

@aduh95 aduh95 Nov 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably also get rid of the other mentions of "parallel" (non blocking, can also happen in a follow up PR)

Suggested change
If `true`, it would run all subtests in parallel.
If `true`, it would run all subtests asynchronously.

or

Suggested change
If `true`, it would run all subtests in parallel.
If `true`, it would run all subtests at once.

Copy link
Contributor

@Ethan-Arrowood Ethan-Arrowood Nov 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer "asynchronously"

If `false`, it would only run one test at a time.
If unspecified, subtests inherit this value from their parent.
Expand Down
Loading