Skip to content
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

doc: update todo test behaviour #51427

Closed
wants to merge 1 commit into from
Closed

doc: update todo test behaviour #51427

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 4 additions & 0 deletions doc/api/test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1250,6 +1250,10 @@ However, the return value from subtests should be used to prevent the parent
test from finishing first and cancelling the subtest
as shown in the following example.

**Note:** Running a `todo` test does not terminate the execution of the test
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Note:** Running a `todo` test does not terminate the execution of the test
Running a `todo` test does not terminate the execution of the test

function. The test function is run without affecting the test result, and
if it fails, it does not end process with exitCode 1.

```js
test('top level test', async (t) => {
// The setTimeout() in the following subtest would cause it to outlive its
Expand Down