Skip to content

Commit ae2a8ff

Browse files
committed
doc: doc: update todo test behavior.
1 parent e0b159e commit ae2a8ff

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/api/test.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,6 +1250,10 @@ However, the return value from subtests should be used to prevent the parent
12501250
test from finishing first and cancelling the subtest
12511251
as shown in the following example.
12521252

1253+
**Note:** Running a `todo` test does not terminate the execution of the test
1254+
function. The test function is run without affecting the test result, and
1255+
if it fails, it does not end process with exitCode 1.
1256+
12531257
```js
12541258
test('top level test', async (t) => {
12551259
// The setTimeout() in the following subtest would cause it to outlive its

0 commit comments

Comments
 (0)